Skip to main content

MCP server for direct HTTP communication with air-Q air quality sensor devices

Project description

mcp-airq

MCP PyPI Python License Tests Coverage

MCP server for air-Q air quality sensor devices. Enables Claude Desktop, Claude Code, and other MCP clients to directly query and configure air-Q devices on your local network.

Built on aioairq, the official async Python library for air-Q.

Installation

pip install mcp-airq

Or run directly with uvx:

uvx mcp-airq

Device Configuration

Create a JSON file with your device(s), e.g. ~/.config/airq-devices.json:

[
  {"address": "192.168.4.1", "password": "your_password", "name": "air-Q Pro", "location": "Living Room", "group": "Home"},
  {"address": "192.168.4.2", "password": "your_password", "name": "air-Q Radon", "location": "Living Room", "group": "Home"},
  {"address": "office_air-q.local", "password": "other_pass", "name": "Office", "group": "Work"}
]

Each entry requires:

  • address — IP address or mDNS hostname (e.g. abcde_air-q.local)
  • password — Device password (default: airqsetup)
  • name (optional) — Human-readable name; defaults to address
  • location (optional) — Physical room/area for grouping (e.g. "Living Room")
  • group (optional) — Second grouping dimension, orthogonal to location (e.g. "Home", "Work")

Then restrict access to the file (it contains passwords):

chmod 600 ~/.config/airq-devices.json

Alternatively, pass the device list inline via the AIRQ_DEVICES environment variable as a JSON string.

Claude Desktop

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "airq": {
      "command": "uvx",
      "args": ["mcp-airq"],
      "env": {
        "AIRQ_CONFIG_FILE": "/home/you/.config/airq-devices.json"
      }
    }
  }
}

Claude Code

Register the server once via the CLI:

claude mcp add airq -e AIRQ_CONFIG_FILE=~/.config/airq-devices.json -- uvx mcp-airq

This writes to ~/.claude/settings.json and is automatically picked up by the Claude Code VSCode extension as well — no separate configuration needed.

If the server fails to connect: MCP servers run in a subprocess that may not inherit your shell's PATH. Replace uvx with its full path (which uvx → e.g. /home/you/.local/bin/uvx):

claude mcp add airq -e AIRQ_CONFIG_FILE=~/.config/airq-devices.json -- /home/you/.local/bin/uvx mcp-airq

OpenAI Codex

Register the server once via the CLI:

codex mcp add airq --env AIRQ_CONFIG_FILE=~/.config/airq-devices.json -- uvx mcp-airq

This writes to ~/.codex/config.toml and is automatically picked up by the Codex VSCode extension as well.

If the server fails to connect: Use the full path to uvx (see note above).

Available Tools

Read-Only

Tool Description
list_devices List all configured air-Q devices (with location/group if set)
get_air_quality Get sensor readings — by device, location, or group
get_device_info Get device metadata (name, model, firmware version)
get_config Get full device configuration
get_logs Get device log entries
identify_device Make device blink its LEDs for visual identification
get_led_theme Get current LED visualization theme
get_possible_led_themes List all available LED visualization themes
get_night_mode Get current night mode configuration
get_brightness_config Get current LED brightness configuration

Configuration

Tool Description
set_device_name Rename a device
set_led_theme Change LED visualization (CO₂, VOC, Humidity, PM2.5, …)
set_night_mode Configure night mode schedule and settings
set_brightness Adjust LED brightness (day/night)
configure_network Set static IP or switch to DHCP

Device Control

Tool Description
restart_device Restart the device (~30s downtime)
shutdown_device Shut down the device (manual restart required)

Multi-Device Support

When multiple devices are configured, specify which device to query:

  • By exact name: "air-Q Pro"
  • By partial match (case-insensitive): "pro", "radon"

If only one device is configured, it is selected automatically.

Location and Group Queries

get_air_quality accepts two optional grouping parameters:

  • location — query all devices in the same room (e.g. "Living Room")
  • group — query all devices sharing a group tag (e.g. "Home")

Both are independent: a device can have a location, a group, both, or neither. Matching is case-insensitive and substring-based.

get_air_quality(location="Living Room")  → air-Q Pro + air-Q Radon
get_air_quality(group="Home")            → air-Q Pro + air-Q Radon + …
get_air_quality(device="air-Q Radon")   → just that one device

Exactly one of device, location, or group may be specified per call.

Example Prompts

  • "How is the air quality in the living room?" — queries all devices at that location
  • "What's the air quality at home?" — queries all devices in the "Home" group
  • "Show me the radon level" — targets the air-Q Radon device by name
  • "Show CO₂ on the LEDs"
  • "Enable night mode from 10 PM to 7 AM"
  • "Set brightness to 50%"
  • "What's in the device log?"
  • "Make the air-Q blink"

Development

git clone https://github.com/CorantGmbH/mcp-airq.git
cd mcp-airq
pip install -e ".[dev]"
pytest

Release Process

  1. Update version in pyproject.toml.
  2. Commit and create a matching Git tag like v0.1.1.
  3. Publish a GitHub Release from that tag.

The publish workflow validates that the release tag matches pyproject.toml, uploads the package to PyPI, and then publishes the same version to the MCP Registry.

License

Apache License 2.0 — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_airq-1.1.1.tar.gz (29.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_airq-1.1.1-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

Details for the file mcp_airq-1.1.1.tar.gz.

File metadata

  • Download URL: mcp_airq-1.1.1.tar.gz
  • Upload date:
  • Size: 29.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mcp_airq-1.1.1.tar.gz
Algorithm Hash digest
SHA256 690467a79eafb62d591d6a6dbaaaa390084b65effd77d4a389a47fb29076ad92
MD5 fce4ec126555f83a344e8e35172867da
BLAKE2b-256 c0ed669f88926d8359d49424bcc21ef6a13cf4adabfba4ebbb8685c3d4fb8baa

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_airq-1.1.1.tar.gz:

Publisher: publish.yml on CorantGmbH/mcp-airq

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mcp_airq-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: mcp_airq-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 22.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mcp_airq-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 32deb81a255a1c98145177baf1c0439c7bd56d57cd9b1167382653410753434d
MD5 cd5d9d58001633c5d0616b379401acc9
BLAKE2b-256 dc0250d9b749506d9cfc7f99a48f99136db80ab80b89efbabbb159fbd756cd59

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_airq-1.1.1-py3-none-any.whl:

Publisher: publish.yml on CorantGmbH/mcp-airq

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page