Home Assistant MCP 服务器

一个用于与 Home Assistant 交互的模型上下文协议 (MCP) 服务器。该服务器提供工具，通过启用 MCP 的应用程序来控制和监控您的 Home Assistant 设备。

本项目是 AI 模型上下文协议 (MCP) 生态系统的一部分。有关 MCP 工具的更多信息和文档，请访问 www.aimcp.info。

功能

• 获取设备状态
• 控制设备状态（开/关）
• 触发自动化
• 列出可用实体

安装

1. 克隆此仓库：

git clone https://github.com/yourusername/homeassistant-server-mcp.git
cd homeassistant-server-mcp

2. 安装依赖项：

npm install

3. 构建项目：

npm run build

4. 通过将以下内容添加到您的 MCP 设置文件（通常位于 VSCode 的 ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json）来配置 MCP 服务器：

{
  "mcpServers": {
    "homeassistant": {
      "command": "node",
      "args": ["/path/to/homeassistant-mcp/homeassistant-server/build/index.js"],
      "env": {
        "HA_URL": "http://your-homeassistant-url:8123",
        "HA_TOKEN": "your-long-lived-access-token"
      }
    }
  }
}

将 your-homeassistant-url 和 your-long-lived-access-token 替换为您的 Home Assistant 实例 URL 和访问令牌。

用法

该服务器提供以下工具：

1. 获取设备状态

// 示例用法
use_mcp_tool({
  server_name: "homeassistant",
  tool_name: "get_state",
  arguments: {
    entity_id: "light.living_room"
  }
});

2. 切换设备状态

// 示例用法
use_mcp_tool({
  server_name: "homeassistant",
  tool_name: "toggle_entity",
  arguments: {
    entity_id: "switch.bedroom",
    state: "on"  // 或 "off"
  }
});

3. 触发自动化

// 示例用法
use_mcp_tool({
  server_name: "homeassistant",
  tool_name: "trigger_automation",
  arguments: {
    automation_id: "automation.morning_routine"
  }
});

4. 列出实体

// 示例用法
use_mcp_tool({
  server_name: "homeassistant",
  tool_name: "list_entities",
  arguments: {
    domain: "light"  // 可选，按域过滤
  }
});

贡献

欢迎贡献！以下是您可以提供帮助的方式：

1. Fork 仓库
2. 创建您的功能分支 (git checkout -b feature/amazing-feature)
3. 提交您的更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打开一个 Pull Request

请确保适当地更新测试并遵循现有的代码风格。

文档

有关 MCP 工具和生态系统的详细文档：

• 访问 www.aimcp.info
• 查看网站上的 MCP 工具目录
• 阅读集成指南和最佳实践

许可证

本项目根据 MIT 许可证获得许可 - 有关详细信息，请参见下文：

MIT License

Copyright (c) 2024 homeassistant-mcp

特此授予任何人免费获得本软件及其相关文档文件（“软件”）副本的许可，以便处理本软件，不受限制，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售本软件副本的权利，并允许向其提供本软件的人员这样做，但须符合以下条件：

上述版权声明和本许可声明应包含在本软件的所有副本或主要部分中。

本软件按“原样”提供，不提供任何形式的明示或暗示的保证，包括但不限于适销性、特定用途适用性和不侵权的保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论是在合同诉讼、侵权诉讼或其他诉讼中，因本软件或本软件的使用或其他交易而引起、产生或与之相关的。

安全

为了安全地使用此服务器：

1. 始终对您的 Home Assistant 实例使用 HTTPS
2. 确保您的访问令牌安全，并且永远不要将其提交到版本控制
3. 定期轮换您的访问令牌
4. 对敏感信息使用环境变量

支持

如果您遇到任何问题或有疑问，请：

1. 检查仓库中现有的问题
2. 如果您的问题尚未报告，请创建一个新问题
3. 报告问题时提供尽可能多的上下文
4. 访问 www.aimcp.info 以获取其他支持资源