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

概览

AI 生成的概览

本地 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 之一。
安装前请注意
令牌和 SSH 凭据可对家庭自动化系统进行广泛控制。许多工具会写入、重启或删除:仪表板、自动化、脚本、场景、辅助元素、文件、应用、实体状态、核心配置及核心重启。SSH 使用 root 账户,SFTP 写入虽限于特定目录,但仍会改动正在使用的配置文件。请勿将 HA_TOKEN、HA_SSH_PASSWORD 和私钥提交到代码仓库,优先使用密钥认证。

安装

在 SourceWeft 中

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

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

其他 MCP 客户端

参照 仓库 中的启动说明。

README

[hass-mcp-server]

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

VariableDescriptionExample
HA_URLHome Assistant base URLhttp://homeassistant.local:8123
HA_TOKENLong-lived access token(from HA Profile → Security)

Optional Variables (for file management)

File management tools require SSH access. See Setting Up SSH below.

VariableDescriptionExample
HA_SSH_HOSTSSH hostnamehomeassistant.local
HA_SSH_PORTSSH port (default: 22)22
HA_SSH_USERSSH username (must be root)root
HA_SSH_KEY_PATHPath to SSH private keySee examples per OS
HA_SSH_PASSWORDSSH password (alternative to key)(your password)

Getting a Long-Lived Access Token

  1. Open your Home Assistant UI
  2. Click your profile icon (bottom-left)
  3. Scroll to Long-Lived Access Tokens under the Security tab
  4. 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.

  1. Install the extension from the Marketplace (or search "Home Assistant MCP Server" in the Extensions view).
  2. Set your Home Assistant URL in Settings → homeAssistantMcp.url.
  3. Run "Home Assistant MCP: Set Access Token" from the Command Palette (Ctrl+Shift+P).
  4. 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):

json
{  "inputs": [    {      "type": "promptString",      "id": "ha-url",      "description": "Home Assistant base URL (e.g. http://homeassistant.local:8123)"    },    {      "type": "promptString",      "id": "ha-token",      "description": "Home Assistant long-lived access token",      "password": true    }  ],  "servers": {    "home-assistant": {      "type": "stdio",      "command": "npx",      "args": ["-y", "@jarahkon/hass-mcp-server@latest"],      "env": {        "HA_URL": "${input:ha-url}",        "HA_TOKEN": "${input:ha-token}"      }    }  }}

With SSH (for file management tools):

json
{  "inputs": [    {      "type": "promptString",      "id": "ha-url",      "description": "Home Assistant base URL (e.g. http://homeassistant.local:8123)"    },    {      "type": "promptString",      "id": "ha-token",      "description": "Home Assistant long-lived access token",      "password": true    }  ],  "servers": {    "home-assistant": {      "type": "stdio",      "command": "npx",      "args": ["-y", "@jarahkon/hass-mcp-server@latest"],      "env": {        "HA_URL": "${input:ha-url}",        "HA_TOKEN": "${input:ha-token}",        "HA_SSH_HOST": "homeassistant.local",        "HA_SSH_USER": "root",        "HA_SSH_KEY_PATH": "/home/you/.ssh/ha_ed25519"      }    }  }}

Claude Desktop

Edit the Claude Desktop config file:

OSConfig file path
Windows%APPDATA%\Claude\claude_desktop_config.json
macOS~/Library/Application Support/Claude/claude_desktop_config.json
Linux~/.config/Claude/claude_desktop_config.json
json
{  "mcpServers": {    "home-assistant": {      "command": "npx",      "args": ["-y", "@jarahkon/hass-mcp-server@latest"],      "env": {        "HA_URL": "http://homeassistant.local:8123",        "HA_TOKEN": "your_long_lived_access_token_here"      }    }  }}

Cursor

Edit ~/.cursor/mcp.json:

json
{  "mcpServers": {    "home-assistant": {      "command": "npx",      "args": ["-y", "@jarahkon/hass-mcp-server@latest"],      "env": {        "HA_URL": "http://homeassistant.local:8123",        "HA_TOKEN": "your_long_lived_access_token_here"      }    }  }}

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

  1. In HA, go to Settings → Apps → App Store
  2. Install Advanced SSH & Web Terminal
  3. In the app configuration, set the username to root (required for SFTP) and enable sftp: true
  4. Configure authentication — either set a password or add your public key to authorized_keys (recommended)
  5. 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.

bash
# Generate a key pair (leave passphrase empty for automated use)ssh-keygen -t ed25519 -f ~/.ssh/ha_ed25519 -C "ha-mcp-server"

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:

yaml
ssh:  username: root  password: ""  authorized_keys:    - "ssh-ed25519 AAAA...contents of ha_ed25519.pub..."  sftp: true

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:

json
"HA_SSH_HOST": "homeassistant.local","HA_SSH_USER": "root","HA_SSH_KEY_PATH": "/home/you/.ssh/ha_ed25519"

Or if using password authentication:

json
"HA_SSH_HOST": "homeassistant.local","HA_SSH_USER": "root","HA_SSH_PASSWORD": "your_ssh_password_here"
SSH key path examples
OSExample HA_SSH_KEY_PATH
WindowsC:/Users/you/.ssh/ha_ed25519
macOS/Users/you/.ssh/ha_ed25519
Linux/home/you/.ssh/ha_ed25519

Tool Reference

Dashboards (6 tools)

ToolDescription
ha_list_dashboardsList all Lovelace dashboards
ha_create_dashboardCreate a new dashboard with url_path, title, icon
ha_update_dashboardUpdate dashboard properties (title, icon, sidebar visibility)
ha_delete_dashboardDelete a dashboard by ID
ha_get_dashboard_configGet the full Lovelace config JSON for a dashboard
ha_save_dashboard_configDeploy a complete Lovelace config to a dashboard

Files (7 tools) — requires SSH

ToolDescription
ha_list_filesList files in a directory on HA (relative to /config/)
ha_read_fileRead file contents from HA
ha_upload_fileUpload a local file to HA via SFTP
ha_upload_file_contentWrite string content directly to a file on HA
ha_delete_fileDelete a file on HA (restricted to safe directories)
ha_mkdirCreate a directory on HA
ha_file_existsCheck if a file or directory exists on HA

Automations, Scripts, Scenes & Helpers (17 tools)

ToolDescription
ha_list_automationsList all automations
ha_get_automationGet a specific automation's config by ID
ha_create_automationCreate a new automation
ha_update_automationUpdate an existing automation
ha_delete_automationDelete an automation
ha_list_scriptsList all scripts
ha_create_scriptCreate a new script
ha_update_scriptUpdate an existing script
ha_delete_scriptDelete a script
ha_list_scenesList all scenes
ha_create_sceneCreate a new scene
ha_update_sceneUpdate an existing scene
ha_delete_sceneDelete a scene
ha_list_helpersList all input helpers (booleans, numbers, etc.)
ha_create_helperCreate an input helper of any type
ha_update_helperUpdate an existing helper
ha_delete_helperDelete a helper

Apps & System (18 tools)

ToolDescription
ha_list_addonsList all installed apps with status
ha_addon_infoGet detailed info about a specific app
ha_install_addonInstall an app by slug
ha_start_addonStart an app
ha_stop_addonStop an app
ha_restart_addonRestart an app
ha_uninstall_addonUninstall an app
ha_addon_optionsGet or set app configuration options
ha_system_infoGet system info (core, OS, supervisor, host)
ha_check_configValidate HA configuration before reload
ha_create_backupCreate a full or partial backup
ha_list_backupsList all backups
ha_restart_coreRestart Home Assistant core
ha_check_apiCheck if the HA API is accessible and responding
ha_get_configGet HA configuration (location, units, version, components)
ha_update_core_configUpdate core configuration (internal/external URL, location, units)
ha_get_componentsList all loaded HA integrations/components
ha_get_error_logGet the Home Assistant error log contents

Entities & Services (18 tools)

ToolDescription
ha_get_statesGet all entity states (optionally filtered by domain)
ha_get_entityGet full state and attributes of a specific entity
ha_call_serviceCall any HA service (turn_on, turn_off, notify, etc.)
ha_list_servicesList available services by domain
ha_render_templateRender a Jinja2 template
ha_list_entity_registryList entities from the entity registry
ha_list_devicesList all devices
ha_list_areasList all areas (rooms)
ha_create_areaCreate a new area
ha_get_historyGet state history for an entity over a time period
ha_get_logbookGet logbook entries (activity log), optionally filtered by entity
ha_get_eventsList all available event types
ha_fire_eventFire a custom event to trigger automations
ha_set_stateSet or create an entity state (virtual sensors, overrides)
ha_delete_stateDelete an entity state
ha_get_calendarsList all calendar entities
ha_get_calendar_eventsGet events from a specific calendar
ha_handle_intentHandle a conversation/voice intent

Architecture

The server uses three transport layers to communicate with Home Assistant:

LayerUsed ForLibrary
REST API (/api/...)Service calls, states, history, templates, Supervisor proxy, automation/script/scene CRUDBuilt-in fetch
WebSocket API (/api/websocket)Dashboard CRUD, helper CRUD, entity registryws
SSH/SFTPFile upload/download/list/delete on HA filesystemssh2-sftp-client
src/├── index.ts              # MCP server entry point, registers all tools├── config.ts             # Environment variable parsing and validation├── ha/│   ├── rest-client.ts    # REST API client with auth header│   ├── ws-client.ts      # WebSocket client with auto-reconnect│   └── sftp-client.ts    # SFTP client with path safety checks└── tools/    ├── dashboards.ts     # 6 dashboard tools    ├── files.ts          # 7 file management tools    ├── automations.ts    # 17 automation/script/scene/helper tools    ├── addons.ts         # 18 app and system tools    └── entities.ts       # 18 entity and service tools
vscode-extension/         # VS Code Marketplace extension wrapper└── src/    └── extension.ts      # Registers MCP server via mcpServerDefinitionProviders API

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 like deps/ or .storage/ are blocked.
  • Token security: Never commit your .env file. The .gitignore already 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
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v1.0.6最新Sep 16, 2026

评分

已满足适用检查项的 50%

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

  • 近 30 天内可连通25 分

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

  • 已声明认证方式10 分

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

  • 已列出工具15 分

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

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