Model Context Protocol Server for Home Assistant

Model Context Protocol Server for Home Assistant

site icon
2025.02.01 217
TypeScript智能家居控制家庭自动化位置服务
Home Assistant MCP Server 是一个基于 Model Context Protocol (MCP) 的智能家居控制服务器,它作为本地 Home Assistant 实例与语言学习模型(LLMs)之间的桥梁,通过自然语言实现对智能家居设备的控制和监控。该服务器提供全面的 API 管理功能,包括设备控制、系统管理、自动化管理等。
View on GitHub

Overview

基本能力

产品定位

Home Assistant MCP Server 是一个智能家居控制中间件,专注于通过自然语言接口实现与 Home Assistant 生态系统的无缝集成。

核心功能

  • 设备控制:通过自然语言控制各种智能设备(灯光、气候、开关、传感器等)
  • 实时更新:通过 Server-Sent Events (SSE) 获取即时状态变更
  • 自动化管理:创建、更新和管理自动化规则
  • 状态监控:跟踪和查询设备状态
  • 系统管理:管理 Home Assistant 插件和软件包
  • 安全认证:基于令牌的认证和速率限制

适用场景

  • 通过自然语言控制智能家居
  • 实时监控家居设备状态
  • 管理 Home Assistant 自动化规则
  • 集成到聊天机器人或语音助手中
  • 开发智能家居相关应用

工具列表

  1. 设备控制工具:控制各种智能设备
  2. 插件管理工具:管理 Home Assistant 插件
  3. 软件包管理工具:通过 HACS 管理软件包
  4. 自动化管理工具:创建和管理自动化规则
  5. 状态查询工具:查询设备状态

常见问题解答

  1. Node.js 版本问题:需要 Node.js 20.10.0 或更高版本
  2. 连接问题:检查 Home Assistant 是否运行,验证主机和令牌
  3. 插件管理问题:验证 Supervisor 访问权限
  4. HACS 集成问题:检查 HACS 安装状态
  5. 自动化问题:验证实体可用性和触发条件

使用教程

使用依赖

  • Node.js 20.10.0 或更高版本
  • NPM 包管理器
  • Docker Compose(推荐)
  • 运行的 Home Assistant 实例
  • Home Assistant 长期访问令牌

安装教程

基本设置

# 克隆仓库
git clone https://github.com/jango-blockchained/homeassistant-mcp.git
cd homeassistant-mcp

# 安装依赖
npm install

# 构建项目
npm run build

Docker 设置(推荐)

# 克隆仓库
git clone https://github.com/jango-blockchained/homeassistant-mcp.git
cd homeassistant-mcp

# 配置环境
cp .env.example .env
# 编辑 .env 文件配置 Home Assistant

# 构建并启动容器
docker compose up -d

# 查看日志
docker compose logs -f

调试方式

  1. 检查服务是否运行:访问 http://localhost:3000/health
  2. 查看日志:docker compose logs -f
  3. 测试 API 端点:使用 curl 或 Postman 测试 API
  4. 开发模式:npm run dev 启用热重载
  5. 运行测试:npx jest --config=jest.config.cjs

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。