Home Assistant 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