ha-mcp-dev 6.4.0.dev163__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ha_mcp_dev-6.4.0.dev163/LICENSE +21 -0
- ha_mcp_dev-6.4.0.dev163/MANIFEST.in +3 -0
- ha_mcp_dev-6.4.0.dev163/PKG-INFO +237 -0
- ha_mcp_dev-6.4.0.dev163/README.md +207 -0
- ha_mcp_dev-6.4.0.dev163/pyproject.toml +222 -0
- ha_mcp_dev-6.4.0.dev163/setup.cfg +4 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/__init__.py +51 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/__main__.py +767 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/_pypi_marker +0 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/auth/__init__.py +10 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/auth/consent_form.py +501 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/auth/provider.py +786 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/client/__init__.py +10 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/client/rest_client.py +929 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/client/websocket_client.py +656 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/client/websocket_listener.py +340 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/config.py +175 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/errors.py +399 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/py.typed +0 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/resources/card_types.json +48 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/resources/dashboard_guide.md +573 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/server.py +189 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/smoke_test.py +108 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/__init__.py +11 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/backup.py +457 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/device_control.py +687 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/enhanced.py +191 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/helpers.py +184 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/registry.py +199 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/smart_search.py +908 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_addons.py +343 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_areas.py +485 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_blueprints.py +279 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_bug_report.py +685 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_calendar.py +391 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_camera.py +149 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_config_automations.py +508 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_config_dashboards.py +1656 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_config_entry_flow.py +223 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_config_helpers.py +929 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_config_info.py +258 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_config_scripts.py +322 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_entities.py +400 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_filesystem.py +589 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_groups.py +306 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_hacs.py +787 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_history.py +717 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_integrations.py +297 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_labels.py +753 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_mcp_component.py +305 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_registry.py +1119 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_resources.py +622 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_search.py +573 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_service.py +211 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_services.py +352 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_system.py +363 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_todo.py +530 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_traces.py +496 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_updates.py +476 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_utility.py +519 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_voice_assistant.py +349 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/tools_zones.py +387 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/tools/util_helpers.py +199 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/utils/__init__.py +30 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/utils/domain_handlers.py +380 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/utils/fuzzy_search.py +339 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/utils/operation_manager.py +442 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/utils/python_sandbox.py +278 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp/utils/usage_logger.py +290 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp_dev.egg-info/PKG-INFO +237 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp_dev.egg-info/SOURCES.txt +76 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp_dev.egg-info/dependency_links.txt +1 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp_dev.egg-info/entry_points.txt +8 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp_dev.egg-info/requires.txt +10 -0
- ha_mcp_dev-6.4.0.dev163/src/ha_mcp_dev.egg-info/top_level.txt +2 -0
- ha_mcp_dev-6.4.0.dev163/tests/__init__.py +1 -0
- ha_mcp_dev-6.4.0.dev163/tests/test_constants.py +15 -0
- ha_mcp_dev-6.4.0.dev163/tests/test_env_manager.py +336 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Julien
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,237 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ha-mcp-dev
|
|
3
|
+
Version: 6.4.0.dev163
|
|
4
|
+
Summary: Home Assistant MCP Server - Complete control of Home Assistant through MCP
|
|
5
|
+
Author-email: Julien <github@qc-h.net>
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/homeassistant-ai/ha-mcp
|
|
8
|
+
Project-URL: Bug Tracker, https://github.com/homeassistant-ai/ha-mcp/issues
|
|
9
|
+
Project-URL: Repository, https://github.com/homeassistant-ai/ha-mcp
|
|
10
|
+
Keywords: mcp,home-assistant,ai,automation,smart-home
|
|
11
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
16
|
+
Classifier: Topic :: Home Automation
|
|
17
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
18
|
+
Requires-Python: <3.14,>=3.13
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
Requires-Dist: fastmcp>=2.11.0
|
|
22
|
+
Requires-Dist: httpx[socks]<1.0,>=0.27.0
|
|
23
|
+
Requires-Dist: jq>=1.8.0; sys_platform != "win32"
|
|
24
|
+
Requires-Dist: pydantic>=2.5.0
|
|
25
|
+
Requires-Dist: python-dotenv>=1.0.0
|
|
26
|
+
Requires-Dist: truststore>=0.10.0
|
|
27
|
+
Requires-Dist: websockets>=12.0
|
|
28
|
+
Requires-Dist: cryptography>=45.0.7
|
|
29
|
+
Dynamic: license-file
|
|
30
|
+
|
|
31
|
+
<div align="center">
|
|
32
|
+
<img src="docs/img/ha-mcp-logo.png" alt="Home Assistant MCP Server Logo" width="300"/>
|
|
33
|
+
|
|
34
|
+
# The Unofficial and Awesome Home Assistant MCP Server
|
|
35
|
+
|
|
36
|
+
<!-- mcp-name: io.github.homeassistant-ai/ha-mcp -->
|
|
37
|
+
|
|
38
|
+
<p align="center">
|
|
39
|
+
<img src="https://img.shields.io/badge/tools-95+-blue" alt="95+ Tools">
|
|
40
|
+
<a href="https://github.com/homeassistant-ai/ha-mcp/releases"><img src="https://img.shields.io/github/v/release/homeassistant-ai/ha-mcp" alt="Release"></a>
|
|
41
|
+
<a href="https://github.com/homeassistant-ai/ha-mcp/actions/workflows/e2e-tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/homeassistant-ai/ha-mcp/e2e-tests.yml?branch=master&label=E2E%20Tests" alt="E2E Tests"></a>
|
|
42
|
+
<a href="LICENSE.md"><img src="https://img.shields.io/github/license/homeassistant-ai/ha-mcp.svg" alt="License"></a>
|
|
43
|
+
<br>
|
|
44
|
+
<a href="https://github.com/homeassistant-ai/ha-mcp/commits/master"><img src="https://img.shields.io/github/commit-activity/m/homeassistant-ai/ha-mcp.svg" alt="Activity"></a>
|
|
45
|
+
<a href="https://github.com/jlowin/fastmcp"><img src="https://img.shields.io/badge/Built%20with-FastMCP-purple" alt="Built with FastMCP"></a>
|
|
46
|
+
<img src="https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fhomeassistant-ai%2Fha-mcp%2Fmaster%2Fpyproject.toml" alt="Python Version">
|
|
47
|
+
<a href="https://github.com/sponsors/julienld"><img src="https://img.shields.io/badge/GitHub_Sponsors-โ-blueviolet" alt="GitHub Sponsors"></a>
|
|
48
|
+
</p>
|
|
49
|
+
|
|
50
|
+
<p align="center">
|
|
51
|
+
<em>A comprehensive Model Context Protocol (MCP) server that enables AI assistants to interact with Home Assistant.<br>
|
|
52
|
+
Using natural language, control smart home devices, query states, execute services and manage your automations.</em>
|
|
53
|
+
</p>
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+

|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## ๐ Get Started
|
|
63
|
+
|
|
64
|
+
### Full guide to get you started with Claude Desktop (~10 min)
|
|
65
|
+
|
|
66
|
+
*No paid subscription required.* Click on your operating system:
|
|
67
|
+
|
|
68
|
+
<p>
|
|
69
|
+
<a href="https://homeassistant-ai.github.io/ha-mcp/guide-macos/"><img src="https://img.shields.io/badge/Setup_Guide_for_macOS-000000?style=for-the-badge&logo=apple&logoColor=white" alt="Setup Guide for macOS" height="120"></a> <a href="https://homeassistant-ai.github.io/ha-mcp/guide-windows/"><img src="https://img.shields.io/badge/Setup_Guide_for_Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white" alt="Setup Guide for Windows" height="120"></a>
|
|
70
|
+
</p>
|
|
71
|
+
|
|
72
|
+
### Quick install (~5 min)
|
|
73
|
+
|
|
74
|
+
<details>
|
|
75
|
+
<summary><b>๐ macOS</b></summary>
|
|
76
|
+
|
|
77
|
+
1. Go to [claude.ai](https://claude.ai) and sign in (or create a free account)
|
|
78
|
+
2. Open **Terminal** and run:
|
|
79
|
+
```sh
|
|
80
|
+
curl -LsSf https://raw.githubusercontent.com/homeassistant-ai/ha-mcp/master/scripts/install-macos.sh | sh
|
|
81
|
+
```
|
|
82
|
+
3. [Download Claude Desktop](https://claude.ai/download) (or restart: Claude menu โ Quit)
|
|
83
|
+
4. Ask Claude: **"Can you see my Home Assistant?"**
|
|
84
|
+
|
|
85
|
+
You're now connected to the demo environment! [Connect your own Home Assistant โ](https://homeassistant-ai.github.io/ha-mcp/guide-macos/#step-6-connect-your-home-assistant)
|
|
86
|
+
|
|
87
|
+
</details>
|
|
88
|
+
|
|
89
|
+
<details>
|
|
90
|
+
<summary><b>๐ช Windows</b></summary>
|
|
91
|
+
|
|
92
|
+
1. Go to [claude.ai](https://claude.ai) and sign in (or create a free account)
|
|
93
|
+
2. Open **Windows PowerShell** (from Start menu) and run:
|
|
94
|
+
```powershell
|
|
95
|
+
irm https://raw.githubusercontent.com/homeassistant-ai/ha-mcp/master/scripts/install-windows.ps1 | iex
|
|
96
|
+
```
|
|
97
|
+
3. [Download Claude Desktop](https://claude.ai/download) (or restart: File โ Exit)
|
|
98
|
+
4. Ask Claude: **"Can you see my Home Assistant?"**
|
|
99
|
+
|
|
100
|
+
You're now connected to the demo environment! [Connect your own Home Assistant โ](https://homeassistant-ai.github.io/ha-mcp/guide-windows/#step-6-connect-your-home-assistant)
|
|
101
|
+
|
|
102
|
+
</details>
|
|
103
|
+
|
|
104
|
+
### ๐ง Setup Wizard for 15+ clients
|
|
105
|
+
|
|
106
|
+
**Claude Code, Gemini CLI, ChatGPT, Open WebUI, VSCode, Cursor, and more.**
|
|
107
|
+
|
|
108
|
+
<p>
|
|
109
|
+
<a href="https://homeassistant-ai.github.io/ha-mcp/setup/"><img src="https://img.shields.io/badge/Open_Setup_Wizard-4A90D9?style=for-the-badge" alt="Open Setup Wizard" height="40"></a>
|
|
110
|
+
</p>
|
|
111
|
+
|
|
112
|
+
Having issues? Check the **[FAQ & Troubleshooting](https://homeassistant-ai.github.io/ha-mcp/faq/)**
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## ๐ฌ What Can You Do With It?
|
|
117
|
+
|
|
118
|
+
Just talk to Claude naturally. Here are some real examples:
|
|
119
|
+
|
|
120
|
+
| You Say | What Happens |
|
|
121
|
+
|---------|--------------|
|
|
122
|
+
| *"Create an automation that turns on the porch light at sunset"* | Creates the automation with proper triggers and actions |
|
|
123
|
+
| *"Add a weather card to my dashboard"* | Updates your Lovelace dashboard with the new card |
|
|
124
|
+
| *"The motion sensor automation isn't working, debug it"* | Analyzes execution traces, identifies the issue, suggests fixes |
|
|
125
|
+
| *"Make my morning routine automation also turn on the coffee maker"* | Reads the existing automation, adds the new action, updates it |
|
|
126
|
+
| *"Create a script that sets movie mode: dim lights, close blinds, turn on TV"* | Creates a reusable script with the sequence of actions |
|
|
127
|
+
|
|
128
|
+
Spend less time configuring, more time enjoying your smart home.
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## โจ Features
|
|
133
|
+
|
|
134
|
+
| Category | Capabilities |
|
|
135
|
+
|----------|--------------|
|
|
136
|
+
| **๐ Search** | Fuzzy entity search, deep config search, system overview |
|
|
137
|
+
| **๐ Control** | Any service, bulk device control, real-time states |
|
|
138
|
+
| **๐ง Manage** | Automations, scripts, helpers, dashboards, areas, zones, groups, calendars, blueprints |
|
|
139
|
+
| **๐ Monitor** | History, statistics, camera snapshots, automation traces, ZHA devices |
|
|
140
|
+
| **๐พ System** | Backup/restore, updates, add-ons, device registry |
|
|
141
|
+
|
|
142
|
+
<details>
|
|
143
|
+
<summary><b>๐ ๏ธ Complete Tool List (97 tools)</b></summary>
|
|
144
|
+
|
|
145
|
+
| Category | Tools |
|
|
146
|
+
|----------|-------|
|
|
147
|
+
| **Search & Discovery** | `ha_search_entities`, `ha_deep_search`, `ha_get_overview`, `ha_get_state` |
|
|
148
|
+
| **Service & Device Control** | `ha_call_service`, `ha_bulk_control`, `ha_get_operation_status`, `ha_get_bulk_status`, `ha_list_services` |
|
|
149
|
+
| **Automations** | `ha_config_get_automation`, `ha_config_set_automation`, `ha_config_remove_automation` |
|
|
150
|
+
| **Scripts** | `ha_config_get_script`, `ha_config_set_script`, `ha_config_remove_script` |
|
|
151
|
+
| **Helper Entities** | `ha_config_list_helpers`, `ha_config_set_helper`, `ha_config_remove_helper` |
|
|
152
|
+
| **Dashboards** | `ha_config_get_dashboard`, `ha_config_set_dashboard`, `ha_config_update_dashboard_metadata`, `ha_config_delete_dashboard`, `ha_get_dashboard_guide`, `ha_get_card_types`, `ha_get_card_documentation` |
|
|
153
|
+
| **Areas & Floors** | `ha_config_list_areas`, `ha_config_set_area`, `ha_config_remove_area`, `ha_config_list_floors`, `ha_config_set_floor`, `ha_config_remove_floor` |
|
|
154
|
+
| **Labels** | `ha_config_get_label`, `ha_config_set_label`, `ha_config_remove_label`, `ha_manage_entity_labels` |
|
|
155
|
+
| **Zones** | `ha_get_zone`, `ha_create_zone`, `ha_update_zone`, `ha_delete_zone` |
|
|
156
|
+
| **Groups** | `ha_config_list_groups`, `ha_config_set_group`, `ha_config_remove_group` |
|
|
157
|
+
| **Todo Lists** | `ha_get_todo`, `ha_add_todo_item`, `ha_update_todo_item`, `ha_remove_todo_item` |
|
|
158
|
+
| **Calendar** | `ha_config_get_calendar_events`, `ha_config_set_calendar_event`, `ha_config_remove_calendar_event` |
|
|
159
|
+
| **Blueprints** | `ha_list_blueprints`, `ha_get_blueprint`, `ha_import_blueprint` |
|
|
160
|
+
| **Device Registry** | `ha_get_device`, `ha_update_device`, `ha_remove_device`, `ha_rename_entity` |
|
|
161
|
+
| **ZHA & Integrations** | `ha_get_zha_devices`, `ha_get_entity_integration_source` |
|
|
162
|
+
| **Add-ons** | `ha_get_addon` |
|
|
163
|
+
| **Camera** | `ha_get_camera_image` |
|
|
164
|
+
| **History & Statistics** | `ha_get_history`, `ha_get_statistics` |
|
|
165
|
+
| **Automation Traces** | `ha_get_automation_traces` |
|
|
166
|
+
| **System & Updates** | `ha_check_config`, `ha_restart`, `ha_reload_core`, `ha_get_system_info`, `ha_get_system_health`, `ha_get_updates` |
|
|
167
|
+
| **Backup & Restore** | `ha_backup_create`, `ha_backup_restore` |
|
|
168
|
+
| **Utility** | `ha_get_logbook`, `ha_eval_template`, `ha_get_domain_docs`, `ha_get_integration` |
|
|
169
|
+
|
|
170
|
+
</details>
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## ๐งช Dev Channel
|
|
175
|
+
|
|
176
|
+
Want early access to new features and fixes? Dev releases (`.devN`) are published on every push to master.
|
|
177
|
+
|
|
178
|
+
**[Dev Channel Documentation](docs/dev-channel.md)** โ Instructions for pip/uvx, Docker, and Home Assistant add-on.
|
|
179
|
+
|
|
180
|
+
---
|
|
181
|
+
|
|
182
|
+
## ๐ค Contributing
|
|
183
|
+
|
|
184
|
+
For development setup, testing instructions, and contribution guidelines, see **[CONTRIBUTING.md](CONTRIBUTING.md)**.
|
|
185
|
+
|
|
186
|
+
For comprehensive testing documentation, see **[tests/README.md](tests/README.md)**.
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
## ๐ Privacy
|
|
191
|
+
|
|
192
|
+
Ha-mcp runs **locally** on your machine. Your smart home data stays on your network.
|
|
193
|
+
|
|
194
|
+
- **Configurable telemetry** โ optional anonymous usage stats
|
|
195
|
+
- **No personal data collection** โ we never collect entity names, configs, or device data
|
|
196
|
+
- **User-controlled bug reports** โ only sent with your explicit approval
|
|
197
|
+
|
|
198
|
+
For full details, see our [Privacy Policy](PRIVACY.md).
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
## ๐ License
|
|
203
|
+
|
|
204
|
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
205
|
+
|
|
206
|
+
---
|
|
207
|
+
|
|
208
|
+
## ๐ Acknowledgments
|
|
209
|
+
|
|
210
|
+
- **[Home Assistant](https://home-assistant.io/)**: Amazing smart home platform (!)
|
|
211
|
+
- **[FastMCP](https://github.com/jlowin/fastmcp)**: Excellent MCP server framework
|
|
212
|
+
- **[Model Context Protocol](https://modelcontextprotocol.io/)**: Standardized AI-application communication
|
|
213
|
+
- **[Claude Code](https://github.com/anthropics/claude-code)**: AI-powered coding assistant
|
|
214
|
+
|
|
215
|
+
## ๐ฅ Contributors
|
|
216
|
+
|
|
217
|
+
- **[@julienld](https://github.com/julienld)** โ Project maintainer & core contributor.
|
|
218
|
+
- **[@kingbear2](https://github.com/kingbear2)** โ Windows UV setup guide.
|
|
219
|
+
- **[@sergeykad](https://github.com/sergeykad)** โ Dashboard card-level CRUD operations, better changelogs and removed the dependency to textdistance/numpy.
|
|
220
|
+
- **[@konradwalsh](https://github.com/konradwalsh)** โ Financial support via [GitHub Sponsors](https://github.com/sponsors/julienld). Thank you! โ
|
|
221
|
+
- **[@cj-elevate](https://github.com/cj-elevate)** โ Integration & entity management tools (enable/disable/delete).
|
|
222
|
+
- **[@kingpanther13](https://github.com/kingpanther13)** โ Dev channel documentation, bulk control validation, OAuth 2.1 docs, tool consolidation, error handling improvements, and native solutions guidance.
|
|
223
|
+
- **[@Danm72](https://github.com/Danm72)** โ Entity registry tools (`ha_set_entity`, `ha_get_entity`) for managing entity properties.
|
|
224
|
+
- **[@Raygooo](https://github.com/Raygooo)** โ SOCKS proxy support.
|
|
225
|
+
|
|
226
|
+
---
|
|
227
|
+
|
|
228
|
+
## ๐ฌ Community
|
|
229
|
+
|
|
230
|
+
- **[GitHub Discussions](https://github.com/homeassistant-ai/ha-mcp/discussions)** โ Ask questions, share ideas
|
|
231
|
+
- **[Issue Tracker](https://github.com/homeassistant-ai/ha-mcp/issues)** โ Report bugs, request features, or suggest tool behavior improvements
|
|
232
|
+
|
|
233
|
+
---
|
|
234
|
+
|
|
235
|
+
## โญ Star History
|
|
236
|
+
|
|
237
|
+
[](https://star-history.com/#homeassistant-ai/ha-mcp&Date)
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<img src="docs/img/ha-mcp-logo.png" alt="Home Assistant MCP Server Logo" width="300"/>
|
|
3
|
+
|
|
4
|
+
# The Unofficial and Awesome Home Assistant MCP Server
|
|
5
|
+
|
|
6
|
+
<!-- mcp-name: io.github.homeassistant-ai/ha-mcp -->
|
|
7
|
+
|
|
8
|
+
<p align="center">
|
|
9
|
+
<img src="https://img.shields.io/badge/tools-95+-blue" alt="95+ Tools">
|
|
10
|
+
<a href="https://github.com/homeassistant-ai/ha-mcp/releases"><img src="https://img.shields.io/github/v/release/homeassistant-ai/ha-mcp" alt="Release"></a>
|
|
11
|
+
<a href="https://github.com/homeassistant-ai/ha-mcp/actions/workflows/e2e-tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/homeassistant-ai/ha-mcp/e2e-tests.yml?branch=master&label=E2E%20Tests" alt="E2E Tests"></a>
|
|
12
|
+
<a href="LICENSE.md"><img src="https://img.shields.io/github/license/homeassistant-ai/ha-mcp.svg" alt="License"></a>
|
|
13
|
+
<br>
|
|
14
|
+
<a href="https://github.com/homeassistant-ai/ha-mcp/commits/master"><img src="https://img.shields.io/github/commit-activity/m/homeassistant-ai/ha-mcp.svg" alt="Activity"></a>
|
|
15
|
+
<a href="https://github.com/jlowin/fastmcp"><img src="https://img.shields.io/badge/Built%20with-FastMCP-purple" alt="Built with FastMCP"></a>
|
|
16
|
+
<img src="https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fhomeassistant-ai%2Fha-mcp%2Fmaster%2Fpyproject.toml" alt="Python Version">
|
|
17
|
+
<a href="https://github.com/sponsors/julienld"><img src="https://img.shields.io/badge/GitHub_Sponsors-โ-blueviolet" alt="GitHub Sponsors"></a>
|
|
18
|
+
</p>
|
|
19
|
+
|
|
20
|
+
<p align="center">
|
|
21
|
+
<em>A comprehensive Model Context Protocol (MCP) server that enables AI assistants to interact with Home Assistant.<br>
|
|
22
|
+
Using natural language, control smart home devices, query states, execute services and manage your automations.</em>
|
|
23
|
+
</p>
|
|
24
|
+
</div>
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+

|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## ๐ Get Started
|
|
33
|
+
|
|
34
|
+
### Full guide to get you started with Claude Desktop (~10 min)
|
|
35
|
+
|
|
36
|
+
*No paid subscription required.* Click on your operating system:
|
|
37
|
+
|
|
38
|
+
<p>
|
|
39
|
+
<a href="https://homeassistant-ai.github.io/ha-mcp/guide-macos/"><img src="https://img.shields.io/badge/Setup_Guide_for_macOS-000000?style=for-the-badge&logo=apple&logoColor=white" alt="Setup Guide for macOS" height="120"></a> <a href="https://homeassistant-ai.github.io/ha-mcp/guide-windows/"><img src="https://img.shields.io/badge/Setup_Guide_for_Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white" alt="Setup Guide for Windows" height="120"></a>
|
|
40
|
+
</p>
|
|
41
|
+
|
|
42
|
+
### Quick install (~5 min)
|
|
43
|
+
|
|
44
|
+
<details>
|
|
45
|
+
<summary><b>๐ macOS</b></summary>
|
|
46
|
+
|
|
47
|
+
1. Go to [claude.ai](https://claude.ai) and sign in (or create a free account)
|
|
48
|
+
2. Open **Terminal** and run:
|
|
49
|
+
```sh
|
|
50
|
+
curl -LsSf https://raw.githubusercontent.com/homeassistant-ai/ha-mcp/master/scripts/install-macos.sh | sh
|
|
51
|
+
```
|
|
52
|
+
3. [Download Claude Desktop](https://claude.ai/download) (or restart: Claude menu โ Quit)
|
|
53
|
+
4. Ask Claude: **"Can you see my Home Assistant?"**
|
|
54
|
+
|
|
55
|
+
You're now connected to the demo environment! [Connect your own Home Assistant โ](https://homeassistant-ai.github.io/ha-mcp/guide-macos/#step-6-connect-your-home-assistant)
|
|
56
|
+
|
|
57
|
+
</details>
|
|
58
|
+
|
|
59
|
+
<details>
|
|
60
|
+
<summary><b>๐ช Windows</b></summary>
|
|
61
|
+
|
|
62
|
+
1. Go to [claude.ai](https://claude.ai) and sign in (or create a free account)
|
|
63
|
+
2. Open **Windows PowerShell** (from Start menu) and run:
|
|
64
|
+
```powershell
|
|
65
|
+
irm https://raw.githubusercontent.com/homeassistant-ai/ha-mcp/master/scripts/install-windows.ps1 | iex
|
|
66
|
+
```
|
|
67
|
+
3. [Download Claude Desktop](https://claude.ai/download) (or restart: File โ Exit)
|
|
68
|
+
4. Ask Claude: **"Can you see my Home Assistant?"**
|
|
69
|
+
|
|
70
|
+
You're now connected to the demo environment! [Connect your own Home Assistant โ](https://homeassistant-ai.github.io/ha-mcp/guide-windows/#step-6-connect-your-home-assistant)
|
|
71
|
+
|
|
72
|
+
</details>
|
|
73
|
+
|
|
74
|
+
### ๐ง Setup Wizard for 15+ clients
|
|
75
|
+
|
|
76
|
+
**Claude Code, Gemini CLI, ChatGPT, Open WebUI, VSCode, Cursor, and more.**
|
|
77
|
+
|
|
78
|
+
<p>
|
|
79
|
+
<a href="https://homeassistant-ai.github.io/ha-mcp/setup/"><img src="https://img.shields.io/badge/Open_Setup_Wizard-4A90D9?style=for-the-badge" alt="Open Setup Wizard" height="40"></a>
|
|
80
|
+
</p>
|
|
81
|
+
|
|
82
|
+
Having issues? Check the **[FAQ & Troubleshooting](https://homeassistant-ai.github.io/ha-mcp/faq/)**
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## ๐ฌ What Can You Do With It?
|
|
87
|
+
|
|
88
|
+
Just talk to Claude naturally. Here are some real examples:
|
|
89
|
+
|
|
90
|
+
| You Say | What Happens |
|
|
91
|
+
|---------|--------------|
|
|
92
|
+
| *"Create an automation that turns on the porch light at sunset"* | Creates the automation with proper triggers and actions |
|
|
93
|
+
| *"Add a weather card to my dashboard"* | Updates your Lovelace dashboard with the new card |
|
|
94
|
+
| *"The motion sensor automation isn't working, debug it"* | Analyzes execution traces, identifies the issue, suggests fixes |
|
|
95
|
+
| *"Make my morning routine automation also turn on the coffee maker"* | Reads the existing automation, adds the new action, updates it |
|
|
96
|
+
| *"Create a script that sets movie mode: dim lights, close blinds, turn on TV"* | Creates a reusable script with the sequence of actions |
|
|
97
|
+
|
|
98
|
+
Spend less time configuring, more time enjoying your smart home.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## โจ Features
|
|
103
|
+
|
|
104
|
+
| Category | Capabilities |
|
|
105
|
+
|----------|--------------|
|
|
106
|
+
| **๐ Search** | Fuzzy entity search, deep config search, system overview |
|
|
107
|
+
| **๐ Control** | Any service, bulk device control, real-time states |
|
|
108
|
+
| **๐ง Manage** | Automations, scripts, helpers, dashboards, areas, zones, groups, calendars, blueprints |
|
|
109
|
+
| **๐ Monitor** | History, statistics, camera snapshots, automation traces, ZHA devices |
|
|
110
|
+
| **๐พ System** | Backup/restore, updates, add-ons, device registry |
|
|
111
|
+
|
|
112
|
+
<details>
|
|
113
|
+
<summary><b>๐ ๏ธ Complete Tool List (97 tools)</b></summary>
|
|
114
|
+
|
|
115
|
+
| Category | Tools |
|
|
116
|
+
|----------|-------|
|
|
117
|
+
| **Search & Discovery** | `ha_search_entities`, `ha_deep_search`, `ha_get_overview`, `ha_get_state` |
|
|
118
|
+
| **Service & Device Control** | `ha_call_service`, `ha_bulk_control`, `ha_get_operation_status`, `ha_get_bulk_status`, `ha_list_services` |
|
|
119
|
+
| **Automations** | `ha_config_get_automation`, `ha_config_set_automation`, `ha_config_remove_automation` |
|
|
120
|
+
| **Scripts** | `ha_config_get_script`, `ha_config_set_script`, `ha_config_remove_script` |
|
|
121
|
+
| **Helper Entities** | `ha_config_list_helpers`, `ha_config_set_helper`, `ha_config_remove_helper` |
|
|
122
|
+
| **Dashboards** | `ha_config_get_dashboard`, `ha_config_set_dashboard`, `ha_config_update_dashboard_metadata`, `ha_config_delete_dashboard`, `ha_get_dashboard_guide`, `ha_get_card_types`, `ha_get_card_documentation` |
|
|
123
|
+
| **Areas & Floors** | `ha_config_list_areas`, `ha_config_set_area`, `ha_config_remove_area`, `ha_config_list_floors`, `ha_config_set_floor`, `ha_config_remove_floor` |
|
|
124
|
+
| **Labels** | `ha_config_get_label`, `ha_config_set_label`, `ha_config_remove_label`, `ha_manage_entity_labels` |
|
|
125
|
+
| **Zones** | `ha_get_zone`, `ha_create_zone`, `ha_update_zone`, `ha_delete_zone` |
|
|
126
|
+
| **Groups** | `ha_config_list_groups`, `ha_config_set_group`, `ha_config_remove_group` |
|
|
127
|
+
| **Todo Lists** | `ha_get_todo`, `ha_add_todo_item`, `ha_update_todo_item`, `ha_remove_todo_item` |
|
|
128
|
+
| **Calendar** | `ha_config_get_calendar_events`, `ha_config_set_calendar_event`, `ha_config_remove_calendar_event` |
|
|
129
|
+
| **Blueprints** | `ha_list_blueprints`, `ha_get_blueprint`, `ha_import_blueprint` |
|
|
130
|
+
| **Device Registry** | `ha_get_device`, `ha_update_device`, `ha_remove_device`, `ha_rename_entity` |
|
|
131
|
+
| **ZHA & Integrations** | `ha_get_zha_devices`, `ha_get_entity_integration_source` |
|
|
132
|
+
| **Add-ons** | `ha_get_addon` |
|
|
133
|
+
| **Camera** | `ha_get_camera_image` |
|
|
134
|
+
| **History & Statistics** | `ha_get_history`, `ha_get_statistics` |
|
|
135
|
+
| **Automation Traces** | `ha_get_automation_traces` |
|
|
136
|
+
| **System & Updates** | `ha_check_config`, `ha_restart`, `ha_reload_core`, `ha_get_system_info`, `ha_get_system_health`, `ha_get_updates` |
|
|
137
|
+
| **Backup & Restore** | `ha_backup_create`, `ha_backup_restore` |
|
|
138
|
+
| **Utility** | `ha_get_logbook`, `ha_eval_template`, `ha_get_domain_docs`, `ha_get_integration` |
|
|
139
|
+
|
|
140
|
+
</details>
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## ๐งช Dev Channel
|
|
145
|
+
|
|
146
|
+
Want early access to new features and fixes? Dev releases (`.devN`) are published on every push to master.
|
|
147
|
+
|
|
148
|
+
**[Dev Channel Documentation](docs/dev-channel.md)** โ Instructions for pip/uvx, Docker, and Home Assistant add-on.
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
## ๐ค Contributing
|
|
153
|
+
|
|
154
|
+
For development setup, testing instructions, and contribution guidelines, see **[CONTRIBUTING.md](CONTRIBUTING.md)**.
|
|
155
|
+
|
|
156
|
+
For comprehensive testing documentation, see **[tests/README.md](tests/README.md)**.
|
|
157
|
+
|
|
158
|
+
---
|
|
159
|
+
|
|
160
|
+
## ๐ Privacy
|
|
161
|
+
|
|
162
|
+
Ha-mcp runs **locally** on your machine. Your smart home data stays on your network.
|
|
163
|
+
|
|
164
|
+
- **Configurable telemetry** โ optional anonymous usage stats
|
|
165
|
+
- **No personal data collection** โ we never collect entity names, configs, or device data
|
|
166
|
+
- **User-controlled bug reports** โ only sent with your explicit approval
|
|
167
|
+
|
|
168
|
+
For full details, see our [Privacy Policy](PRIVACY.md).
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## ๐ License
|
|
173
|
+
|
|
174
|
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
## ๐ Acknowledgments
|
|
179
|
+
|
|
180
|
+
- **[Home Assistant](https://home-assistant.io/)**: Amazing smart home platform (!)
|
|
181
|
+
- **[FastMCP](https://github.com/jlowin/fastmcp)**: Excellent MCP server framework
|
|
182
|
+
- **[Model Context Protocol](https://modelcontextprotocol.io/)**: Standardized AI-application communication
|
|
183
|
+
- **[Claude Code](https://github.com/anthropics/claude-code)**: AI-powered coding assistant
|
|
184
|
+
|
|
185
|
+
## ๐ฅ Contributors
|
|
186
|
+
|
|
187
|
+
- **[@julienld](https://github.com/julienld)** โ Project maintainer & core contributor.
|
|
188
|
+
- **[@kingbear2](https://github.com/kingbear2)** โ Windows UV setup guide.
|
|
189
|
+
- **[@sergeykad](https://github.com/sergeykad)** โ Dashboard card-level CRUD operations, better changelogs and removed the dependency to textdistance/numpy.
|
|
190
|
+
- **[@konradwalsh](https://github.com/konradwalsh)** โ Financial support via [GitHub Sponsors](https://github.com/sponsors/julienld). Thank you! โ
|
|
191
|
+
- **[@cj-elevate](https://github.com/cj-elevate)** โ Integration & entity management tools (enable/disable/delete).
|
|
192
|
+
- **[@kingpanther13](https://github.com/kingpanther13)** โ Dev channel documentation, bulk control validation, OAuth 2.1 docs, tool consolidation, error handling improvements, and native solutions guidance.
|
|
193
|
+
- **[@Danm72](https://github.com/Danm72)** โ Entity registry tools (`ha_set_entity`, `ha_get_entity`) for managing entity properties.
|
|
194
|
+
- **[@Raygooo](https://github.com/Raygooo)** โ SOCKS proxy support.
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
## ๐ฌ Community
|
|
199
|
+
|
|
200
|
+
- **[GitHub Discussions](https://github.com/homeassistant-ai/ha-mcp/discussions)** โ Ask questions, share ideas
|
|
201
|
+
- **[Issue Tracker](https://github.com/homeassistant-ai/ha-mcp/issues)** โ Report bugs, request features, or suggest tool behavior improvements
|
|
202
|
+
|
|
203
|
+
---
|
|
204
|
+
|
|
205
|
+
## โญ Star History
|
|
206
|
+
|
|
207
|
+
[](https://star-history.com/#homeassistant-ai/ha-mcp&Date)
|