Zigbee2mqtt Mcp

io.github.alexpfau由 GitHub 账号 alexpfau 发布v0.7.0更新于 Oct 24, 2026

Administer a Zigbee2MQTT estate: health, mesh diagnostics, OTA, pairing, device management.

概览

AI 生成的概览

让助手通过 MQTT 管理 Zigbee2MQTT 网络:网格健康、链路质量、配对、绑定、上报配置与固件更新。

可以做什么
直接与 Zigbee2MQTT 的 MQTT 桥接 API 通信,因此无论是否使用 Home Assistant 都能工作。读取类工具涵盖代理连接状态、桥接信息、设备列表与详情、全网健康报告、带孤立节点检测的网格拓扑、分组、桥接日志以及协调器内存检查。写入类工具分层开放:safe 模式增加配对、设备选项、重命名、配置、interview、绑定、上报、分组和状态设置;full 模式再增加设备移除、OTA 刷写、Touchlink 和桥接重启。
适用场景
当你需要设备控制之下的那一层时使用:弱链路、反复重新入网的设备、电量将尽的电池、interview 状态、OTA 可用性、permit_join 窗口、绑定和上报间隔。如果只是想让助手开关 Home Assistant 已暴露的灯,则不需要它。
运行要求
通过 npx 以 stdio 在本地运行;需要 Node.js 22 或更高版本,并能访问 Zigbee2MQTT 所用的 MQTT 代理。必须提供 Z2M_MQTT_URL,且应指向代理而非 Zigbee2MQTT 前端端口。可选:代理需要认证时使用 Z2M_MQTT_USERNAME 与 Z2M_MQTT_PASSWORD,与 mqtt.base_topic 一致的 Z2M_BASE_TOPIC,TLS 材料路径,以及 Z2M_WRITE_MODE。
安装前请注意
safe 模式可通过 z2m_set_state 操作网格上的任何设备,包括门锁、阀门和警报器;若在意这一点请使用 Z2M_WRITE_MODE=off。z2m_permit_join 会在窗口期内向附近任何 Zigbee 设备开放网络。full 模式增加不可逆操作(移除设备、OTA 刷写、Touchlink、桥接重启),可能损坏硬件;这些工具要求 confirm: true,且默认不启用。代理凭据来自 Z2M_MQTT_USERNAME 与 Z2M_MQTT_PASSWORD,输出与日志中会被脱敏。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Zigbee2mqtt Mcp,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

zigbee2mqtt-mcp

[CI] [npm version] [License: MIT] [zigbee2mqtt-mcp MCP server] [Zigbee2MQTT MCP on mcprush]

A Model Context Protocol server for administering a Zigbee2MQTT estate.

Most Zigbee integrations already let an assistant turn a light on. This one is for the layer underneath: mesh health, weak links, devices that keep rejoining, stale batteries, firmware updates, pairing, binding, reporting intervals and device options — the things you normally open the Zigbee2MQTT frontend for.

It talks directly to the Zigbee2MQTT MQTT bridge API, so it works regardless of whether you use Home Assistant, Node-RED, openHAB or nothing at all. Tested against Zigbee2MQTT 2.x; several tools depend on bridge endpoints that only exist there, including bridge/health, device/binds/clear and the OTA scheduling topics.

Why this exists

If you already run Home Assistant, your Zigbee devices are exposed there and an assistant can control them. What Home Assistant does not expose is the bridge itself: link quality, mesh topology, interview state, OTA availability, permit_join, device options, bindings and reporting configuration. This server fills exactly that gap.

Design

  • No database. Zigbee2MQTT publishes its bridge topics as retained messages, so a fresh subscription yields a complete picture in a few hundred milliseconds. The server keeps only the latest payload per topic in memory.
  • No daemon. Pure stdio. It starts and dies with the MCP session.
  • Correlated requests. Every bridge/request/* carries a transaction id and is matched to its bridge/response/*, so concurrent calls cannot cross wires.
  • Tiered writes. Destructive operations are gated behind a write mode and an explicit confirm argument.

Install

Requires Node.js 22 or newer and network access to the MQTT broker that Zigbee2MQTT uses.

bash
npx zigbee2mqtt-mcp

VS Code / GitHub Copilot

Add to your MCP configuration:

jsonc
{  "servers": {    "zigbee2mqtt": {      "command": "npx",      "args": ["-y", "zigbee2mqtt-mcp"],      "env": {        "Z2M_MQTT_URL": "mqtt://192.168.1.10:1883",        "Z2M_MQTT_USERNAME": "mqtt",        "Z2M_MQTT_PASSWORD": "${input:z2mPassword}"      }    }  }}

Claude Desktop

json
{  "mcpServers": {    "zigbee2mqtt": {      "command": "npx",      "args": ["-y", "zigbee2mqtt-mcp"],      "env": {        "Z2M_MQTT_URL": "mqtt://192.168.1.10:1883"      }    }  }}

Point Z2M_MQTT_URL at your MQTT broker, not at the Zigbee2MQTT frontend port. If Zigbee2MQTT's configuration.yaml says mqtt.server: mqtt://192.168.1.10:1883, use that value verbatim.

Behind a corporate npm proxy? If npm config get registry is not https://registry.npmjs.org/, your proxy's upstream feed may not carry this package. Add an explicit override to the args rather than changing your global registry: "args": ["-y", "--registry", "https://registry.npmjs.org/", "zigbee2mqtt-mcp"]

Configuration

VariableDefaultPurpose
Z2M_MQTT_URLrequiredBroker URL. mqtt://, mqtts://, ws://, wss://
Z2M_MQTT_USERNAME / Z2M_MQTT_PASSWORD–Broker credentials
Z2M_BASE_TOPICzigbee2mqttMust match mqtt.base_topic
Z2M_MQTT_CLIENT_IDzigbee2mqtt-mcp-<pid>Override if your broker requires a fixed client ID
Z2M_WRITE_MODEsafeoff, safe or full
Z2M_LOG_LEVELerrorDiagnostics on stderr
Z2M_WEAK_LINK_THRESHOLD30Link quality below this is flagged
Z2M_LOW_BATTERY_THRESHOLD20Battery percentage below this is flagged
Z2M_STALE_HOURS24Hours of silence before a device is stale
Z2M_CONNECT_TIMEOUT_MS10000Broker connect timeout
Z2M_REQUEST_TIMEOUT_MS15000Default bridge request timeout
Z2M_MQTT_REJECT_UNAUTHORIZEDtrueSet false for self-signed TLS
Z2M_MQTT_CA / _CERT / _KEY–Paths to TLS material

Write modes

Tools above the active tier are not registered at all, so a model cannot reach for them.

ModeExposes
offRead-only tools
safeDefault. Read plus non-destructive writes: pairing, options, rename, configure, interview, binding, reporting, groups, state
fullEverything, including device removal, OTA flashing, Touchlink and bridge restart

Irreversible tools (z2m_remove_device, z2m_ota_update, z2m_touchlink, z2m_restart_bridge, z2m_set_bridge_options) additionally require confirm: true on every call. Three safe tools reduce state rather than only adding to it, so they are annotated destructive: z2m_rename_device, z2m_manage_group and z2m_bind. Their reducing actions also require confirm: true — z2m_manage_group (remove, remove_all_members) and z2m_bind (clear). z2m_rename_device is annotated destructive because it breaks anything referencing the old name, but stays unconfirmed since renaming back restores it.

Every tool also advertises MCP tool annotations so a client can decide what may run without prompting:

AnnotationMeaning here
readOnlyHint: trueThe nine read tools. They never change the network.
destructiveHint: truez2m_remove_device, z2m_ota_update, z2m_touchlink, z2m_restart_bridge, z2m_set_bridge_options, plus z2m_rename_device, z2m_manage_group and z2m_bind
idempotentHintTrue where repeating the call has no additional effect
openWorldHint: trueAlways — every tool reaches a live Zigbee network

Annotations describe the tool, not the tier: a safe tool can still be destructive. The tier decides what is registered, the annotation tells the client what to ask about.

Opt in to the destructive tier only when you want it:

jsonc
"env": { "Z2M_WRITE_MODE": "full" }

Tools

Read

ToolPurpose
z2m_connection_statusBroker reachability, TLS posture and cached message counts — reports instead of throwing, even when nothing is configured yet
z2m_bridge_infoVersion, coordinator, channel, PAN ID, permit_join, restart_required, runtime stats
z2m_list_devicesFilter and sort devices by type, availability, link quality, battery, pending update
z2m_get_deviceExposes, settable options, endpoints, bindings, configured reportings, current state
z2m_health_reportWhole-estate audit in one call
z2m_network_mapMesh topology with parent, depth, link quality, orphan detection
z2m_list_groupsGroups, members and scenes
z2m_get_logsBridge logs and lifecycle events, buffered or watched live
z2m_coordinator_checkRouters missing from the coordinator's memory (Texas Instruments adapters only)

Safe writes

z2m_check_updates, z2m_permit_join, z2m_set_device_options, z2m_rename_device, z2m_configure_device, z2m_interview_device, z2m_set_state, z2m_manage_group, z2m_bind, z2m_configure_reporting

Full writes

z2m_remove_device, z2m_ota_update, z2m_restart_bridge, z2m_set_bridge_options, z2m_touchlink

Data availability caveats

Some fields depend on your Zigbee2MQTT configuration. The server detects what is available and tells you rather than silently returning nothing.

FieldRequiresIf missing
last_seenadvanced.last_seen set to e.g. ISO_8601 (default is disable)Staleness checks are skipped and a hint is returned
availabilityavailability.enabled: trueOffline detection is skipped and a hint is returned
linkquality, battery, updateLive device traffic — Zigbee2MQTT does not retain device state topicsPass collect_seconds to listen briefly, or use z2m_network_map for authoritative link quality
z2m_coordinator_checkAn adapter that supports coordinator backups (TI zStack, Silicon Labs EmberZNet; not deCONZ or ZiGate)Returns an error on unsupported adapters; z2m_bridge_info reports the expectation

Security notes

  • The broker URL may carry credentials (mqtt://user:pass@host). They are redacted everywhere the URL is echoed back to a model or written to a log, and error text from the MQTT client is scrubbed before it leaves the process. Zigbee2MQTT logs its own broker URL at startup, so lines relayed by z2m_get_logs are scrubbed too.
  • safe mode can actuate anything on the mesh via z2m_set_state, including locks, valves and sirens. Use off if that matters.
  • z2m_permit_join opens the network to any nearby Zigbee device for the duration of the window. It is in safe because it is routine and reversible, but it is a security boundary.

Example prompts

  • "Is my Zigbee network healthy?"
  • "Which devices have the weakest signal?"
  • "Which batteries need replacing?"
  • "Any firmware updates available?"
  • "Open the network for pairing via the kitchen router for two minutes."
  • "This sensor stopped reporting temperature — fix it."
  • "Bind the hallway remote to the hallway light so it works if the bridge is down."

Development

bash
npm installnpm run buildnpm run watch
# Unit tests. No broker required; they run on every push across Node 22 and 24.npm test
# Manual smoke test against a real instanceZ2M_MQTT_URL=mqtt://192.168.1.10:1883 node scripts/smoke.mjsZ2M_MQTT_URL=mqtt://192.168.1.10:1883 node scripts/smoke.mjs z2m_list_devices '{"only_problems":true}'
# Sequential read-after-write test. Renames a device and creates a group, then# restores both, including on failure. Set Z2M_TEST_DEVICE to pick the device,# or ROUNDTRIP_GROUPS_ONLY=1 to skip the rename.Z2M_MQTT_URL=mqtt://192.168.1.10:1883 node scripts/roundtrip.mjs

Note that an MCP server may receive requests concurrently. When testing ordering, await each response before sending the next, as roundtrip.mjs does — piping several requests at once will produce misleading results.

The unit tests cover health classification, capability detection, topic routing, write-mode gating and configuration parsing. They are broker-free by design, so anything that needs a live mesh belongs in scripts/ instead.

A passing suite only proves the tests ran, so scripts/mutate.mjs breaks the source one change at a time and checks the suite notices each one:

bash
node scripts/mutate.mjs          # every mutantnode scripts/mutate.mjs redact   # only mutants whose name matches

A surviving mutant marks behavior nothing actually tests, and exits non-zero. Add a mutant alongside any fix worth keeping fixed.

Releases are tag-driven: npm version <patch|minor|major> then git push --follow-tags. CI publishes to npm with provenance, rewrites server.json's version from the tag and publishes to the MCP Registry, then creates the GitHub release. The version committed in server.json is therefore not authoritative — the tag is.

Safety

This server can remove devices from your network and flash firmware. Both are irreversible and OTA failures can brick hardware. Those tools live in the full tier, which is not enabled by default — you must opt in with Z2M_WRITE_MODE=full. Broker credentials are read from the environment and never logged.

Status

Early release. Developed and tested against a 50-device EmberZNet estate on Zigbee2MQTT 2.12.x. Other adapters (Texas Instruments, deCONZ/ConBee, zStack), TLS and WebSocket brokers, and large estates are unverified. Bug reports and pull requests are very welcome — please include your adapter type and Zigbee2MQTT version from z2m_bridge_info.

License

MIT

来源:README.md,提交 3957aa6

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.7.0最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分