Ha Mcp

> Breaking change (v7.3.0): ha_config_set_yaml has been moved to [beta](docs/beta.md).

# The Unofficial and Awesome Home Assistant MCP Server

A comprehensive Model Context Protocol (MCP) server that enables AI assistants to interact with Home Assistant. Using natural language, control smart home devices, query states, execute services and manage your automations.

---

---

🚀 Get Started

Full guide to get you started with Claude Desktop (~10 min)

No paid subscription required. Click on your operating system:

        

Quick install (~5 min)

🍎 macOS

1. Go to claude.ai and sign in (or create a free account)
2. Open Terminal and run:

``sh curl -LsSf https://raw.githubusercontent.com/homeassistant-ai/ha-mcp/master/scripts/install-macos.sh | sh ``

1. Download Claude Desktop (or restart: Claude menu → Quit)
2. Ask Claude: "Can you see my Home Assistant?"

You're now connected to the demo environment! Connect your own Home Assistant →

🐧 Linux

Anthropic doesn't ship Claude Desktop for Linux, so pick one path:

Claude Desktop — free, via the community build:

1. Install the community Claude Desktop for Linux build and sign in with a free claude.ai account
2. Open Terminal and run:

``sh curl -LsSf https://raw.githubusercontent.com/homeassistant-ai/ha-mcp/master/scripts/install-linux.sh | sh ``

1. Restart Claude Desktop, then ask: "Can you see my Home Assistant?"

Claude Code — official CLI, requires a paid Claude plan:

1. Install Claude Code: curl -fsSL https://claude.ai/install.sh | bash
2. Configure ha-mcp, then run claude:

``sh curl -LsSf https://raw.githubusercontent.com/homeassistant-ai/ha-mcp/master/scripts/install.sh | sh -s -- --claude-code ``

1. Start claude, run /mcp to confirm, then ask: "Can you see my Home Assistant?"

Full Linux guide →

🪟 Windows

1. Go to claude.ai and sign in (or create a free account)
2. Open Windows PowerShell (from Start menu) and run:

``powershell irm https://raw.githubusercontent.com/homeassistant-ai/ha-mcp/master/scripts/install-windows.ps1 | iex ``

1. Download Claude Desktop (or restart: File → Exit)
2. Ask Claude: "Can you see my Home Assistant?"

You're now connected to the demo environment! Connect your own Home Assistant →

🏠 Home Assistant OS (Add-on)

1. Add the repository to your Home Assistant instance:

[](https://my.home-assistant.io/redirect/supervisoraddaddonrepository/?repositoryurl=https%3A%2F%2Fgithub.com%2Fhomeassistant-ai%2Fha-mcp)

1. Install "Home Assistant MCP Server" from the Add-on Store and wait for it to complete
2. Click Start, then open the Logs tab to find your unique MCP URL
3. Configure your AI client with that URL

No token or credential setup needed — the add-on connects to Home Assistant automatically.

[Full add-on documentation →](homeassistant-addon/DOCS.md)

🌐 Remote Access (Nabu Casa / Webhook Proxy)

Already have Nabu Casa or another reverse proxy pointing at your Home Assistant? The Webhook Proxy add-on routes MCP traffic through your existing setup — no separate tunnel or port forwarding needed.

1. Install the MCP Server add-on (see above) and the Webhook Proxy add-on from the same store
2. Start the webhook proxy and restart Home Assistant when prompted
3. Copy the webhook URL from the add-on logs:

`` MCP Server URL (remote): https://xxxxx.ui.nabu.casa/api/webhook/mcp_xxxxxxxx ``

1. Configure your AI client with that URL

For other remote access methods (Cloudflare Tunnel, custom reverse proxy), see the Setup Wizard.

Webhook proxy documentation →

🧙 Setup Wizard for 15+ clients

Claude Code, Gemini CLI, ChatGPT, Open WebUI, VSCode, Cursor, and more.

Having issues? Check the FAQ & Troubleshooting

---

💬 What Can You Do With It?

Just talk to Claude naturally. Here are some real examples:

| You Say | What Happens | |---------|--------------| | "Create an automation that turns on the porch light at sunset" | Creates the automation with proper triggers and actions | | "Add a weather card to my dashboard" | Updates your Lovelace dashboard with the new card | | "The motion sensor automation isn't working, debug it" | Analyzes execution traces, identifies the issue, suggests fixes | | "Make my morning routine automation also turn on the coffee maker" | Reads the existing automation, adds the new action, updates it | | "Create a script that sets movie mode: dim lights, close blinds, turn on TV" | Creates a reusable script with the sequence of actions |

Spend less time configuring, more time enjoying your smart home.

---

✨ Features

| Category | Capabilities | |----------|--------------| | 🔍 Search | Fuzzy entity search, deep config search, system overview | | 🏠 Control | Any service, bulk device control, real-time states | | 🔧 Manage | Automations, scripts, helpers, dashboards, areas, zones, groups, calendars, blueprints | | 📊 Monitor | History, statistics, camera snapshots, automation traces, ZHA devices | | 💾 System | Backup/restore, updates, add-ons, device registry | | 🔒 Safety | Read Only Mode toggle, per-tool enable/disable, tool security policies (user approval), automatic edit backups |

Complete Tool List (85 tools)

| Category | Tools | |----------|-------| | Add-ons | ha_get_addon, ha_manage_addon | | Areas & Floors | ha_list_floors_areas, ha_remove_area_or_floor, ha_set_area_or_floor | | Assist | ha_manage_pipeline | | Automations | ha_config_get_automation, ha_config_remove_automation, ha_config_set_automation | | Blueprints | ha_get_blueprint, ha_import_blueprint | | Calendar | ha_config_get_calendar_events, ha_config_remove_calendar_event, ha_config_set_calendar_event | | Camera | ha_get_camera_image | | Dashboard | ha_get_dashboard_screenshot (beta) | | Dashboards | ha_config_delete_dashboard_resource, ha_config_delete_dashboard, ha_config_get_dashboard, ha_config_list_dashboard_resources, ha_config_set_dashboard_resource, ha_config_set_dashboard | | Device Registry | ha_get_device, ha_remove_device, ha_set_device | | Energy | ha_manage_energy_prefs | | Entity Registry | ha_get_entity_exposure, ha_get_entity, ha_remove_entity, ha_set_entity | | Files | ha_delete_file (beta), ha_list_files (beta), ha_read_file (beta), ha_write_file (beta) | | Groups | ha_config_list_groups, ha_config_remove_group, ha_config_set_group | | HACS | ha_get_hacs_info, ha_manage_hacs | | Helper Entities | ha_config_list_helpers, ha_config_set_helper, ha_remove_helpers_integrations | | History & Statistics | ha_get_automation_traces, ha_get_history, ha_get_logs | | Integrations | ha_get_integration, ha_get_system_health, ha_set_integration_enabled | | Labels & Categories | ha_config_get_category, ha_config_get_label, ha_config_remove_category, ha_config_remove_label, ha_config_set_category, ha_config_set_label | | Matter | ha_manage_radio | | Scenes | ha_config_get_scene, ha_config_remove_scene, ha_config_set_scene | | Scripts | ha_config_get_script, ha_config_remove_script, ha_config_set_script | | Search & Discovery | ha_get_overview, ha_get_state, ha_search | | Service & Device Control | ha_bulk_control, ha_call_event, ha_call_service, ha_get_operation_status, ha_list_services | | System | ha_config_set_yaml (beta), ha_get_updates, ha_manage_backup, ha_manage_custom_tool (beta), ha_manage_theme, ha_reload_core, ha_restart | | Todo Lists | ha_get_todo, ha_remove_todo_item, ha_set_todo_item | | Utilities | ha_eval_template, ha_install_mcp_tools (beta), ha_report_issue | | Zones | ha_get_zone, ha_remove_zone, ha_set_zone |

---

🆚 ha-mcp vs. Home Assistant's built-in MCP Server

Home Assistant ships its own MCP Server integration. It is built on the Assist pipeline, so a connected MCP client can read and control the entities you have exposed to Assist and run the intents Assist understands — handy for voice-style control of already-exposed devices.

ha-mcp is a standalone server built for configuring, building, and debugging your smart home, not just controlling it. On top of device control, it adds capabilities the built-in integration does not have:

| Capability | Built-in MCP Server | ha-mcp | |------------|:-------------------:|:------:| | Control exposed devices, query states | Yes | Yes | | Entity scope | Only entities exposed to Assist | Everything in Home Assistant | | Create / edit automations, scripts, scenes | No | Yes | | Build & edit dashboards | No | Yes | | Debug automations from traces, read history & logs | No | Yes | | Manage helpers, areas, zones, labels, groups | No | Yes | | Backups, add-ons, HACS, device & entity registry | No | Yes |

Rule of thumb: Use the built-in integration for voice-style control of devices you have already exposed; use ha-mcp when you want an AI assistant that can also build and maintain your Home Assistant setup.

---

🔌 Custom Component (hamcptools) (beta)

Some tools require a companion custom component installed in Home Assistant. Standard HA APIs do not expose file system access or YAML config editing. This component provides both.

Tools that require the component:

| Tool | Description | |------|-------------| | ha_config_set_yaml (beta) | Safely add, replace, or remove top-level YAML keys in configuration.yaml and package files (automatic backup, validation, and config check) | | ha_list_files (beta) | List files in allowed directories | | ha_read_file (beta) | Read files from allowed paths (config YAML, logs, and allowed directories) | | ha_write_file (beta) | Write files to allowed directories | | ha_delete_file (beta) | Delete files from allowed directories |

All other tools work without the component. These five return an error with installation instructions if the component is missing.

These tools also require feature flags: HAMCP_ENABLE_FILESYSTEM_TOOLS=true (file tools) and ENABLE_YAML_CONFIG_EDITING=true (YAML editing). To enable the ha_install_mcp_tools installer tool, set HAMCP_ENABLE_CUSTOM_COMPONENT_INTEGRATION=true.

Install using HACS (recommended)

[](https://my.home-assistant.io/redirect/hacs_repository/?owner=homeassistant-ai&repository=ha-mcp&category=integration)

To add manually: open HACS > Integrations > three-dot menu > Custom repositories > add https://github.com/homeassistant-ai/ha-mcp (category: Integration) > Download.

After installing, restart Home Assistant. Then open Settings > Devices & Services > Add Integration and search for Home Assistant MCP Server Custom Component.

On Home Assistant OS / Supervised, the integration offers to add the add-on repository and install and start the Home Assistant MCP Server add-on for you — no need to add the add-on repository by hand. On Container / Core installs (no Supervisor) there is no add-on; run the server via Docker or pip and the integration just sets up the file/YAML services.

Install manually

Copy custom_components/ha_mcp_tools/ from this repository into your HA config/custom_components/ directory. Restart Home Assistant, then add the integration as described above.

---

🧠 Better Results with Agent Skills

This server gives your AI agent tools to control Home Assistant. For better configurations, pair it with Home Assistant Agent Skills — domain knowledge that teaches the agent Home Assistant best practices.

An MCP server can create automations, helpers, and dashboards, but it has no opinion on how to structure them. Without domain knowledge, agents tend to over-rely on templates, pick the wrong helper type, or produce automations that are hard to maintain. The skills fill that gap: native constructs over Jinja2 workarounds, correct helper selection, safe refactoring workflows, and proper use of automation modes.

Bundled Skills (built-in)

Skills from homeassistant-ai/skills are bundled and served as MCP resources via skill:// URIs. Any MCP client that supports resources can discover them automatically — no manual installation needed. For tool-only clients (claude.ai, etc.), the same skills are reachable through the polymorphic ha_get_skill_guide tool — call it with no args to list bundled skills, with a skill arg to list its files, or with skill + file to read content. Resources are not auto-injected into context — clients must explicitly request them, so idle context cost is just the metadata listing.

ha_get_skill_guide is a mandatory tool: the catalog always exposes it (it can't be disabled) so tool-only clients never see a silently missing skill surface.

Skills can still be installed manually for clients that prefer local skill files — see the skills repo for instructions.

---

🔍 Tool Discovery for AI Agents

By default, the full tool catalog (~84 tools) is listed to the client through the standard MCP tools/list response. Clients with deferred / on-demand tool loading (Claude Sonnet, Claude Opus) handle that fine — tools are pulled into context only when needed, so idle context cost is near-zero.

For models without deferred tool support — Claude Haiku, Gemini, ChatGPT OpenAI-compatible local models, smaller open-weights models — listing the full tool catalog up front adds a lot of idle context and can overwhelm smaller models. To address that, the server ships with a search-based discovery mode built on top of FastMCP's BM25 search transform.

Smaller or local LLMs (Ollama, etc.)

If your model can't see the tools or your Home Assistant, it may be getting handed the whole tool catalog at once and struggling with it. It's recommended to try the following to see if it helps:

• Enable tool search (ENABLE_TOOL_SEARCH=true, or the add-on option below). Instead of listing every tool up front, the server defers the catalog behind a search interface so the model pulls in only the tools it needs, when it needs them.
• Raise the model's context window above the default. Local runtimes ship with small defaults (Ollama's num_ctx is one example) that can't hold a large tool set plus the conversation — increase it well beyond the default.

Enable search-based discovery

Set ENABLETOOLSEARCH=true (or toggle the option in the HA add-on). The full catalog is replaced in the tool list with four entry points plus a small set of always-visible "pinned" tools (hasearchentities, hagetoverview, ha_restart, etc.). All tools remain callable directly by name once discovered:

| Tool | Purpose | |------|---------| | ha_search_tools | BM25 keyword search across all tools. Returns name, description, parameters, and annotations (readOnlyHint / destructiveHint) so the agent can pi

…

Source & license

This open-source MCP server is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: homeassistant-ai
• Source: homeassistant-ai/ha-mcp
• License: MIT

Install and usage instructions live in the source repository linked above.