返回 MCP 目录
public公开dns本地运行

ha-mcp-server

Home Assistant的MCP服务器,提供基于SSE的工具来检查和优化自动化、脚本、场景和助手。

article

README

🚀 家庭助手 MCP 服务器

家庭助手 MCP 服务器提供了基于 SSE 的工具,可用于检查和优化您的自动化、脚本、情景和辅助工具,为家庭自动化管理带来便利。

🚀 快速开始

按照以下步骤安装并启动家庭助手 MCP 服务器:

  1. 克隆仓库并进入该目录。
  2. 复制 .env.example.env 并填写值。
  3. 执行 npm install
  4. 执行 npm run build
  5. 执行 npm start

服务器将在 http://localhost:${PORT}/sse(默认 8080)运行。使用 X-API-Key 标头进行身份验证。

✨ 主要特性

  • SSE 运输:带有 API 密钥身份验证。
  • 丰富工具:提供 get_automations, get_scripts, get_scenes, get_helpers 等工具。
  • 优化功能:通过 recommend_optimizations 进行优化,可基于获取的数据提供简单推荐。

📦 安装指南

  1. 克隆仓库并进入该目录。
  2. 复制 .env.example.env 并填写值。
  3. 执行 npm install
  4. 执行 npm run build
  5. 执行 npm start

服务器将在 http://localhost:${PORT}/sse(默认 8080)运行。使用 X-API-Key 标头进行身份验证。

💻 使用示例

基础用法

以下是使用各个工具的示例代码:

# 列出所有自动化
get_automations()

# 列出所有脚本
get_scripts()

# 列出所有情景
get_scenes()

# 列出所有辅助工具
get_helpers()

# 基于获取的数据提供简单推荐
recommend_optimizations()

📚 详细文档

工具说明

  • get_automations:列出所有自动化。
  • get_scripts:列出所有脚本。
  • get_scenes:列出所有情景。
  • get_helpers:列出所有辅助工具。
  • recommend_optimizations:基于获取的数据提供简单推荐。

📄 许可证

本项目采用 MIT License。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端