Home Assistant MCP Server
io.github.jarahkon由 GitHub 帳號 jarahkon 發布v1.0.6更新於 Oct 24, 2026
MCP server for full Home Assistant control — dashboards, files, automations, add-ons, and more
概覽
本機 MCP 伺服器,讓助理全面控制 Home Assistant:儀表板、自動化、檔案、應用程式、實體與服務。
- 可以做什麼
- 列出、建立、更新、刪除 Lovelace 儀表板並部署完整設定
- 透過 SFTP 上傳、讀取、列出、建立和刪除 HA 執行個體上的檔案
- 對自動化、指令碼、場景和輸入輔助元素進行完整的增刪改查
- 安裝、啟動、停止、重新啟動、解除安裝和設定應用程式,並檢視系統資訊、驗證設定、備份、重新啟動核心和讀取錯誤記錄
- 查詢實體狀態、呼叫服務、轉譯範本、瀏覽實體/裝置/區域登錄、讀取歷史與日誌、觸發事件、設定狀態和查詢行事曆
- 適用情境
- 適合希望讓助理代為建立或修改 Home Assistant 儀表板、撰寫自動化與指令碼、查看實體狀態與歷史,或管理應用程式和備份,而不必自己在 HA 介面中逐項操作的情況。
- 執行需求
- 透過 npx 在本機執行,需要 Node.js 20+。需要具備 Supervisor 的 Home Assistant 安裝、HA_URL 基礎位址,以及 HA_TOKEN 中的長期存取權杖。檔案工具另需安裝 Advanced SSH & Web Terminal 應用程式並啟用 SFTP,並設定 HA_SSH_HOST、HA_SSH_USER(root)以及 HA_SSH_KEY_PATH 或 HA_SSH_PASSWORD 其中之一。
安裝
在 SourceWeft 中
- 開啟 儀表板中的 Home Assistant MCP Server,將其新增到工作區。
- 為需要使用其工具的對話啟用該服務。
Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。
其他 MCP 客戶端
參照 儲存庫 中的啟動說明。
README
hass-mcp-server
[npm version] [CI] [License: MIT]
MCP server for full Home Assistant control. AI agents (GitHub Copilot, Claude, etc.) can manage your dashboards, automations, files, apps, entities, and more — so you never have to touch HA settings yourself.
[Install VS Code Extension] [Install in VS Code] [Install in VS Code Insiders]Features
- Dashboard management — Create, update, delete Lovelace dashboards and deploy full dashboard configs
- File management — Upload, read, list, and delete files on your HA instance via SFTP (e.g. custom cards, images, HTML files)
- Automations, scripts, scenes — Full CRUD for automations, scripts, and scenes
- Input helpers — Create and manage input_boolean, input_number, input_text, input_select, input_datetime, input_button, counter, and timer helpers
- App management — Install, start, stop, restart, uninstall, and configure apps (add-ons)
- Entity & service control — Query states, call services, render templates, browse entity/device/area registries
- System tools — System info, config validation, backups, core restart, error log
- Event & calendar tools — List event types, fire events, calendar queries
- State management — Set, delete entity states; handle intents
66 tools across 5 categories, using three HA transport layers: REST API, WebSocket API, and SSH/SFTP.
Prerequisites
- Home Assistant OS (or any HA installation with Supervisor)
- Long-lived access token — Create one in HA → Profile → Security → Long-Lived Access Tokens
- Node.js 20+
- (Optional) SSH app — Required only for file management tools. Install "Advanced SSH & Web Terminal" from the app store.
Quick Start
No installation needed — your MCP client runs the server automatically via npx. Just add the configuration to your client and you're ready to go.
Configuration
The server is configured through environment variables set in your MCP client's configuration file. The client injects these into the server process at launch time — you never need to set system-wide environment variables.
Required Variables
Optional Variables (for file management)
File management tools require SSH access. See Setting Up SSH below.
Getting a Long-Lived Access Token
- Open your Home Assistant UI
- Click your profile icon (bottom-left)
- Scroll to Long-Lived Access Tokens under the Security tab
- Click Create Token, give it a name, and copy the token
MCP Client Setup
Choose the setup for your MCP client below. In each case, add the configuration and the client will automatically download and run the server via npx.
Tip: You can omit the
HA_SSH_*variables if you don't need file management tools. The server will start without SFTP and only fail if you try to use a file tool.
VS Code (GitHub Copilot)
Option A: Install the extension (recommended)
The easiest way — install the Home Assistant MCP Server extension from the VS Code Marketplace. It registers the MCP server automatically and stores your credentials securely.
- Install the extension from the Marketplace (or search "Home Assistant MCP Server" in the Extensions view).
- Set your Home Assistant URL in Settings →
homeAssistantMcp.url. - Run "Home Assistant MCP: Set Access Token" from the Command Palette (
Ctrl+Shift+P). - The MCP server appears in Copilot Chat automatically.
For file management, configure the SSH settings (homeAssistantMcp.ssh.*) and optionally run "Home Assistant MCP: Set SSH Password".
Option B: One-click install via mcp.json
Click the badge at the top of this README, or use the link below. VS Code will prompt you for your Home Assistant URL and access token.
[Install in VS Code]Option C: Manual mcp.json setup
Create .vscode/mcp.json in your workspace (or add to your User Settings for global access):
With SSH (for file management tools):
Claude Desktop
Edit the Claude Desktop config file:
Cursor
Edit ~/.cursor/mcp.json:
Other MCP Clients
Any MCP client that supports stdio servers will work. Use npx as the command with -y @jarahkon/hass-mcp-server@latest as args, and pass HA_URL and HA_TOKEN in the env block.
Setting Up SSH (for file management)
File management tools (ha_upload_file, ha_read_file, ha_list_files, etc.) require SSH access to your Home Assistant instance.
1. Install the SSH app in Home Assistant
- In HA, go to Settings → Apps → App Store
- Install Advanced SSH & Web Terminal
- In the app configuration, set the username to
root(required for SFTP) and enablesftp: true - Configure authentication — either set a password or add your public key to
authorized_keys(recommended) - Start the app and check the logs to confirm it started successfully
2. Generate an SSH key (recommended)
Key-based authentication is more secure than passwords.
This creates ~/.ssh/ha_ed25519 (private key) and ~/.ssh/ha_ed25519.pub (public key).
Add the public key contents to the app configuration in HA:
3. Add SSH variables to your MCP client config
Add these environment variables alongside HA_URL and HA_TOKEN in the env block of your MCP client configuration:
Or if using password authentication:
SSH key path examples
Tool Reference
Dashboards (6 tools)
Files (7 tools) — requires SSH
Automations, Scripts, Scenes & Helpers (17 tools)
Apps & System (18 tools)
Entities & Services (18 tools)
Architecture
The server uses three transport layers to communicate with Home Assistant:
Security Notes
- SFTP path restrictions: Read operations are allowed anywhere under
/config/. Write and delete operations are restricted to safe subdirectories (www/,custom_components/,themes/,blueprints/,scripts/,automations/) and specific files (configuration.yaml,automations.yaml,scripts.yaml,scenes.yaml). Write operations to system directories likedeps/or.storage/are blocked. - Token security: Never commit your
.envfile. The.gitignorealready excludes it. - SSH authentication: Prefer SSH key-based auth (
HA_SSH_KEY_PATH) over passwords. Never commit private keys or passwords to source control.
License
MIT
來源:README.md,提交 1ba71d8
工具
0版本歷史
1- v1.0.6最新Sep 16, 2026
評分
已滿足適用檢查項的 50%
該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。
- 近 30 天內可連通25 分
請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。
- 已宣告認證方式10 分
請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。
- 已列出工具15 分
請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。
- 描述必需15 分
- 圖示10 分
- 文件15 分
- 授權條款10 分