Mcp2mqtt

🚀 mcp2mqtt サーバーガイド

mcp2mqttサーバーは、MCPプロトコルをサポートするクライアントとMQTT間の通信を可能にするサーバーです。このガイドでは、mcp2mqttサーバーのインストール、設定、実行方法を説明します。

🚀 クイックスタート

まずは、mcp2mqttサーバーをインストールし、設定して実行する手順を紹介します。

📦 インストール

インストール手順

1. 仮想環境の作成：

   uv venv .venv
   

2. 仮想環境のアクティブ化：
   • Windows:

   .venv\Scripts\activate

   - Linux/macOS:
   

   source .venv/bin/activate

3. 開発依存関係のインストール：

   uv pip install --editable .
   

設定説明

MCPプロトコルをサポートするクライアント（Claude DesktopやClineなど）の設定ファイルに以下の内容を追加します。

デフォルトのデモパラメータを使用する場合：

{
    "mcpServers": {
        "mcp2mqtt": {
            "command": "uv",
            "args": [
                "--directory",
                "你的实际路径/mcp2mqtt",  // 例: "C:/Users/Administrator/Documents/develop/my-mcp-server/mcp2mqtt"
                "run",
                "mcp2mqtt"
            ]
        }
    }
}

パラメータファイル名を指定する場合：

{
    "mcpServers": {
        "mcp2mqtt": {
            "command": "uv",
            "args": [
                "--directory",
                "你的实际路径/mcp2mqtt",  // 例: "C:/Users/Administrator/Documents/develop/my-mcp-server/mcp2mqtt"
                "run",
                "mcp2mqtt",
                "--config", // オプションパラメータ、設定ファイル名を指定
                "Pico"  // オプションパラメータ、設定ファイル名を指定、_config.yamlの拡張子は不要
            ]
        }
    }
}

設定ファイルの場所

プログラムは以下の順序で設定ファイルを検索します：

1. 現在の作業ディレクトリ（開発テストに適しています）：

   • パス：./config.yaml
   • 例：C:\Projects でプログラムを実行する場合、C:\Projects\config.yaml を検索します。

2. ユーザーのホームディレクトリ（個人使用を推奨）：

   # Windowsシステム
   C:\Users\用户名\.mcp2mqtt\config.yaml
   
   # macOSシステム
   /Users/用户名/.mcp2mqtt/config.yaml
   
   # Linuxシステム
   /home/用户名/.mcp2mqtt/config.yaml
   

3. システムレベルの設定（多ユーザー環境に適しています）：

   # Windowsシステム（管理者権限が必要）
   C:\ProgramData\mcp2mqtt\config.yaml
   
   # macOS/Linuxシステム（root権限が必要）
   /etc/mcp2mqtt/config.yaml
   

プログラムは上記の順序で設定ファイルを検索し、最初に見つかった有効な設定ファイルを使用します。あなたのニーズに応じて適切な場所を選択してください：

• 開発テスト：現在のディレクトリを使用
• 個人使用：ユーザーのホームディレクトリを使用することをおすすめ
• 多ユーザー環境：システムレベルの設定を使用

サーバーの実行

# 仮想環境がアクティブ化されていることを確認
.venv\Scripts\activate

# サーバーを実行（デフォルト設定config.yamlを使用、例ではLOOP_BACKを使用してシリアルポートをシミュレート、実際のシリアルポートとシリアルデバイスは不要）
uv run src/mcp2mqtt/服务器端

📚 ドキュメント

• APIドキュメント：mcp2mqtt API ドキュメント
• 関連画像：
  • 設定例画像
  • 実行画面画像

さらなる支援が必要な場合は、公式ドキュメントを参照するか、サポートチームにお問い合わせください。