Skip to main content

mcp-server-zwave-js-ui

PyPI Python versions CI License: MIT

An MCP server for managing a Z-Wave network through Z-Wave JS UI. It connects to the zwave-js-server WebSocket that Z-Wave JS UI exposes and surfaces the mesh — controller, nodes, values, and configuration parameters — as tools an MCP client (e.g. Claude) can call.

Status: early / read + write + lifecycle. Read-only introspection, write control (values, config parameters, node name/location, associations), and admin/lifecycle operations (re-interview, route rebuild, inclusion/exclusion, remove failed node) are available. Set ZWAVE_JS_READ_ONLY to hide every mutating tool and expose only the read tools. Triggering an OTA firmware update is still on the roadmap.

Quickstart

  1. In Z-Wave JS UI, make sure the Z-Wave JS Server WebSocket is enabled (Settings → Home Assistant → WS Server; default port 3000). See What it connects to.

  2. Add the server to Claude Code, pointing ZWAVE_JS_URL at that WebSocket. No manual install needed — uvx fetches and runs the published package:

    claude mcp add zwave-js-ui \
      --env ZWAVE_JS_URL=ws://<host>:3000 \
      -- uvx mcp-server-zwave-js-ui
    
  3. Ask Claude about your mesh — it calls the read-only tools to answer:

    "Which Z-Wave controller am I running, and how many nodes are on the network?"

    "List my Z-Wave nodes and flag any that are dead or asleep."

For other MCP clients, isolated installs, and configuration details, see the sections below.

What it connects to

Z-Wave JS UI runs two servers: the web UI (default port 8091) and the Z-Wave JS Server WebSocket (default port 3000) that Home Assistant and this MCP server talk to. Point ZWAVE_JS_URL at the WebSocket, not the UI.

Install

Requires Python 3.12+.

pip install mcp-server-zwave-js-ui
# or, isolated:
pipx install mcp-server-zwave-js-ui
# or, no install:
uvx mcp-server-zwave-js-ui

Configure

Variable Default Description
ZWAVE_JS_URL ws://localhost:3000 WebSocket URL of the Z-Wave JS Server.
ZWAVE_JS_READ_ONLY (unset) Set to 1/true/yes/on to hide all write and admin tools (only the read tools are registered).

Use with Claude Code

claude mcp add zwave-js-ui \
  --env ZWAVE_JS_URL=ws://<host>:3000 \
  -- uvx mcp-server-zwave-js-ui

Or add it to an MCP client config directly:

{
  "mcpServers": {
    "zwave-js-ui": {
      "command": "uvx",
      "args": ["mcp-server-zwave-js-ui"],
      "env": { "ZWAVE_JS_URL": "ws://<host>:3000" }
    }
  }
}

Tools

Write and admin tools (everything below the read-only rows) are hidden from the registry when ZWAVE_JS_READ_ONLY is set.

Read-only

Tool Description
zwave_controller_info Controller and network summary (home id, versions, RF region, node counts).
zwave_list_nodes One-line summary of every node (status, readiness, security, device).
zwave_node_info Full detail for a node (device class, command classes, endpoints, signal).
zwave_node_values A node's current values, excluding configuration parameters.
zwave_node_config A node's configuration parameters with current values and metadata.
zwave_association_groups A node's association groups and their capabilities.
zwave_associations A node's current associations, keyed by group.
zwave_rebuild_routes_status Whether a network-wide route rebuild (heal) is in progress.
zwave_firmware_update_status Whether an OTA firmware update is in progress.

Write control (level 2)

Tool Description
zwave_set_value Set a value by id (on/off/dim/etc.); validated against live metadata.
zwave_set_config_parameter Set a manufacturer configuration parameter (optional bit mask).
zwave_set_node_name Set a node's friendly name.
zwave_set_node_location Set a node's location label.
zwave_add_association Associate a target node into a source node's group.
zwave_remove_association Remove a target node from a source node's group.

Admin / lifecycle (level 3)

Tool Description
zwave_reinterview_node Re-run a node's interview to refresh capabilities and values.
zwave_rebuild_node_routes Rebuild mesh routes for a single node.
zwave_begin_rebuilding_routes / zwave_stop_rebuilding_routes Start/stop a network-wide route rebuild (heal).
zwave_remove_failed_node Remove a controller-flagged failed node from the network.
zwave_begin_inclusion / zwave_stop_inclusion Enter/leave inclusion mode to add a node.
zwave_begin_exclusion / zwave_stop_exclusion Enter/leave exclusion mode to remove a node.

Note on secure inclusion: interactive S2 security bootstrap (DSK/PIN grant) can't complete through this stateless server — use the Z-Wave JS UI for secure inclusion.

Roadmap

  • Trigger OTA firmware updates. Reporting update status is available (zwave_firmware_update_status), but starting a flash streams progress events over minutes, which the per-call connection model can't observe within a single tool call; delivering it needs a persistent-connection design.

Development

git clone https://github.com/cacack/mcp-server-zwave-js-ui
cd mcp-server-zwave-js-ui
uv sync --extra dev            # create .venv from the checked-in uv.lock
uv run pytest
uv run ruff check . && uv run ruff format --check .

See CLAUDE.md for architecture and design notes.

License

MIT

Download files

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

Source Distribution

mcp_server_zwave_js_ui-0.4.0.tar.gz (112.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_server_zwave_js_ui-0.4.0-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_zwave_js_ui-0.4.0.tar.gz.

File metadata

  • Download URL: mcp_server_zwave_js_ui-0.4.0.tar.gz
  • Upload date:
  • Size: 112.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for mcp_server_zwave_js_ui-0.4.0.tar.gz
Algorithm Hash digest
SHA256 910dda4a657f7bcd37f88ce87e6311ea30fabd235277a5234f49276259e19c45
MD5 72f2735c5227099d160fa5b24c3b8d92
BLAKE2b-256 d81da0c589123e6676ca99e91c7095e02a9f5238e0d97342395982a6bf7c6a42

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_server_zwave_js_ui-0.4.0.tar.gz:

Publisher: release.yml on cacack/mcp-server-zwave-js-ui

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_server_zwave_js_ui-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_zwave_js_ui-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fb53c73aea8203f25621452533d65838bd1aff5a45f85b03c96265f6896d79e9
MD5 4924f958374d6ef71207fff800059589
BLAKE2b-256 7b8cce2fbbf02ae5738bdf2606c515963d459b50a22b7ae65f2e970ac86e0e64

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_server_zwave_js_ui-0.4.0-py3-none-any.whl:

Publisher: release.yml on cacack/mcp-server-zwave-js-ui

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

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 files

0.3.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page