Emqx MCP Server

🚀 EMQX カスタム MCP サーバープラグイン

このプロジェクトは、EMQX MQTT ブローカーと相互作用するためのカスタム MCP（メッセージセンタープロトコル）サーバーです。自然言語処理（NLP）インターフェースを通じて、ユーザーがMQTTブローカーに対して、接続中のクライアントの一覧表示、クライアントの詳細情報の取得、メッセージの発行、クライアントの接続解除などの操作を実行できます。

🚀 クイックスタート

このセクションでは、EMQX カスタム MCP サーバープラグインのクイックスタートについて説明します。以下の手順に従って、サーバーをセットアップしてください。

✨ 主な機能

• 自然言語処理（NLP）インターフェースを通じて、MQTTブローカーに対する操作を可能にします。
• 接続中のクライアントの一覧表示、クライアントの詳細情報の取得、メッセージの発行、クライアントの接続解除などの操作ができます。

📦 インストール

1. リポジトリをクローンする

git clone https://github.com/Benniu/emqx-mcp-server.git

2. 依存関係をインストールする

プロジェクトのルートディレクトリで以下のコマンドを実行します。

npm install

3. MCP サーバーを設定する

config.json という名前のファイルを作成し、以下の内容を追加します。

{
  "emqxApiUrl": "https://your-emqx-instance.com:8443/api/v5",
  "apiKey": "<あなたのAPIキー>",
  "apiSecret": "<あなたのAPIキー>"
}

💻 使用例

基本的な使用法

以下は、MCPサーバーとの対話の例です。

ユーザー

MQTTブローカーに接続しているすべてのクライアントを一覧表示してください。

LLM 応答

現在、あなたのMQTTブローカーに接続しているクライアントは以下の通りです。
接続中のクライアント：
- クライアントID: mqttx_2232bdb1
- ユーザー名: test
- プロトコルバージョン: MQTT v5
...
現在、あなたのMQTTブローカーには1つのクライアントが接続しています。この特定のクライアントの詳細情報を取得するか、MQTTブローカーに対して他の操作を実行しますか？

ユーザー

はい、このクライアントの詳細情報を提供してください。

LLM 応答

このクライアントの詳細情報を取得します。
...
以下は、クライアント "mqttx_2232bdb1" の詳細情報です。

**基本情報:**
- **クライアントID:** mqttx_2232bdb1
- **ユーザー名:** test
...
**接続詳細:**
- **状態:** 接続中
- **作成日時:** 2025-03-02T05:29:51.103+00:00
...
このクライアントに対して、トピックへのメッセージの発行やクライアントの接続解除などの操作を実行しますか？

ユーザー

詩を作成して、トピック '/poem' に品質1で送信してください。

LLM 応答

詩を作成し、MQTTを通じてトピック '/poem' に発行します。この操作を実行します。
...
詩をトピック '/poem' に品質1で正常に発行しました。メッセージは配信され、ID: 00062F55A1EFB1156ABC481240B30000 です。

送信した詩は以下の通りです。

- 信号は電波の中を駆け巡り、
- 目に見えない糸で私たちをつなぎます。
- デバイスはささやき声で交わり、
- デジタルの溝を越えます。
- メッセージは落葉のように舞い降り、
- 雲の上から現実の世界に。
- 自由で束縛されることなく、
- 静けさの中で無言に伝わります。
- 今や機械がつながりの橋となり、
- 世界中に情報を届けます。
- 未来の足音は軽やかに、
- 時の流れの中を進みます。

詩の作成を続けるか、他の操作を実行しますか？

ユーザー

クライアント 'mqttx_2232bdb1' の接続を解除してください。

LLM 応答

クライアント 'mqttx_2232bdb1' の接続を正常に解除しました。さらなる操作が必要な場合は、いつでもお知らせください！

高度な使用法

以下は、MCPサーバーとの対話の他の例です。

1. すべてのクライアントを一覧表示する

ユーザー: "MQTTブローカーに接続しているすべてのクライアントを一覧表示してください。"

2. クライアントの詳細情報を取得する

ユーザー: "クライアント 'mqttx_2232bdb1' の詳細情報を提供してください。"

3. メッセージを発行する

ユーザー: "トピック '/test' に 'Hello EMQX' という内容のメッセージを発行してください。"

4. クライアントの接続を解除する

ユーザー: "クライアント 'mqttx_2232bdb1' の接続を解除してください。"

📚 ドキュメント

MCP サーバーを実行する

方法1: UVツールを使用して実行する

uv main.ts config.json

方法2: リポジトリをクローンして実行する

1. ターミナルでこのリポジトリをクローンします。

   git clone https://github.com/Benniu/emqx-mcp-server.git
   

2. config.json ファイルを開き、以下のフィールドを修正します。

   • emqxApiUrl: あなたの EMQX インスタンスのアドレス。
   • apiKey: あなたの API キー。
   • apiSecret: あなたの API キー。

3. ターミナルで MCP サーバーを実行します。

   npm start
   

📄 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。具体的な条項は以下の通りです。

Copyright (c) 2024, あなたの名前 <あなたのメールアドレス>
このソフトウェアまたはその一部の使用、複製、修正、および配布は、以下の条件の下で許可されます。
- この著作権表示を保持すること。
- 配布されるすべての派生作品に元の著作権表示を含めること。

商品性、特定の目的への適合性、および非侵害性を含む、明示的な保証は一切ありません。いかなる場合も、著者およびその貢献者は、直接的、間接的、付随的、特殊的、例示的、または結果的な損害に対して責任を負いません。

🔧 技術詳細

プロジェクト目標

• 拡張性: より多くの MQTT 関連操作をサポートします。
• 使いやすさ: シンプルなコマンドラインと API インターフェースを提供します。
• 信頼性: すべての操作が正確に実行されることを保証します。

何か質問や提案があれば、いつでもご連絡ください！