Home Assistant MCP 服务器

一个用于与 Home Assistant 交互的 Model Context Protocol (MCP) 服务器。此服务器提供了通过支持 MCP 的应用程序控制和监控您的 Home Assistant 设备的工具。

此项目是 AI Model Context Protocol (MCP) 生态系统的一部分。有关 MCP 工具的更多信息和文档，请访问 www.aimcp.info。

功能

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

安装

1. 克隆此仓库：

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

1. 安装依赖项：

npm install

1. 构建项目：

npm run build

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

{
  "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. 获取设备状态

// Example usage
use_mcp_tool({
  server_name: "homeassistant",
  tool_name: "get_state",
  arguments: {
    entity_id: "light.living_room"
  }
});

2. 切换设备状态

// Example usage
use_mcp_tool({
  server_name: "homeassistant",
  tool_name: "toggle_entity",
  arguments: {
    entity_id: "switch.bedroom",
    state: "on"  // or "off"
  }
});

3. 触发自动化

// Example usage
use_mcp_tool({
  server_name: "homeassistant",
  tool_name: "trigger_automation",
  arguments: {
    automation_id: "automation.morning_routine"
  }
});

4. 列出实体

// Example usage
use_mcp_tool({
  server_name: "homeassistant",
  tool_name: "list_entities",
  arguments: {
    domain: "light"  // optional, filters by domain
  }
});

贡献

欢迎贡献！您可以通过以下方式帮助我们：

1. 分叉仓库
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

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

安全

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

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

支持

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

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