Home Assistant MCP

🚀 家庭助手 MCP 服務器

家庭助手 MCP 服務器是一個與 Home Assistant 集成的模型上下文協議 (MCP) 服務器項目，它提供了強大的智能家庭控制功能，讓用戶可以更便捷地管理家庭設備。

🚀 快速開始

📦 安裝指南

按照說明安裝 Home Assistant 並獲取一個長期訪問令牌。

• Home Assistant 入門指南

Claude Desktop

在 MacOS 上：~/Library/Application\ Support/Claude/claude_desktop_config.json 在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json%

✨ 主要特性

提示

服務器為每個領域的工具集提供提示。

工具

服務器實現對各種 Home Assistant 領域的控制。目前支持：

• 💡 燈光：開/關，亮度調節
• 🌡️ 氣候：溫度控制，HVAC 模式
• 🔒 鎖：上鎖/解鎖功能
• 🚨 報警控制面板：佈防/撤防安全系統
• 💧 加溼器：溼度控制

示例工具包括：

light-turn_on()
climate-turn_off()
alarm_control_panel-disarm()
lock-lock()
humidifier-turn_off()

📚 詳細文檔

配置

環境變量

在根目錄下創建一個 .env 文件，內容如下：

HOMEASSISTANT_TOKEN=your_long_lived_access_token_here # 在您的 Home Assistant 實例中獲取長生命週期訪問令牌後添加
HOMEASSISTANT_BASE_URL=your_home_assistant_url_here # 例如 http://homeassistant.local:8123

開發

構建和發佈

為了準備分發包：

1. 同步依賴項並更新鎖文件：

uv sync

2. 構建包分佈：

uv build

這將在 dist/ 目錄下創建源代碼和輪分佈。

3. 發佈到 PyPI：

uv publish

注意：您需要通過環境變量或命令行標誌設置 PyPI 憑證：

• 令牌：--token 或 UV_PUBLISH_TOKEN
• 或用戶名/密碼：--username/UV_PUBLISH_USERNAME 和 --password/UV_PUBLISH_PASSWORD

調試

由於 MCP 服務器通過標準輸入輸出運行，調試可能具有挑戰性。為了獲得最佳調試體驗，我們強烈推薦使用 MCP 檢查器。

您可以通過 npm 執行以下命令啟動 MCP 檢查器：

npx @modelcontextprotocol/inspector

貢獻指南

代碼規範

1. 保持代碼簡潔易懂。
2. 遵循項目目錄結構。
3. 提交信息包含問題編號和說明。

如何貢獻

1. 叉分倉庫：git clone https://github.com/yourusername/home-assistant-mcp.git
2. 創建功能分支：git checkout -b feature/problemNumber
3. 提交更改：git commit -m "feat: 問題描述"
4. 推送到遠程倉庫：git push origin feature/problemNumber
5. 創建拉取請求。

依賴管理

使用 package.json 管理項目依賴，安裝依賴時運行：

npm install

📄 許可證

MIT License