Emqx MCP Server

🚀 EMQX 自定義 MCP 服務器插件

本項目是一個用於與 EMQX MQTT 代理交互的自定義 MCP（消息中樞協議）服務器。它允許用戶藉助自然語言處理（NLP）接口對 MQTT 代理執行操作，例如列出連接的客戶端、獲取客戶端詳細信息、發佈消息以及斷開客戶端連接，為用戶操作 MQTT 代理提供了便捷途徑。

🚀 快速開始

本插件能讓您通過自然語言處理接口輕鬆操作 EMQX MQTT 代理，下面為您介紹使用前的準備工作。

✨ 主要特性

• 支持通過自然語言處理（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
...
目前有 1 個客戶端連接到您的 MQTT 代理。您是否需要獲取此特定客戶端的詳細信息，還是希望對 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 服務器

方式一: 使用 UV 工具運行

uv main.ts config.json

方式二: 克隆倉庫後運行

1. 在終端中克隆此倉庫：

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

2. 打開 config.json 文件並修改以下字段：

   • emqxApiUrl: 您的 EMQX 實例地址。
   • apiKey: 您的 API 密鑰。
   • apiSecret: 您的 API 密鑰。

3. 在終端中運行 MCP 服務器：

   npm start
   

🔧 技術細節

項目目標

• 可擴展性：支持更多 MQTT 相關操作。
• 易用性：提供簡潔的命令行和 API 接口。
• 可靠性：確保所有操作準確無誤。

如果您有任何問題或建議，請隨時聯繫我！

📄 許可證

本項目使用 MIT 許可證，具體條款如下：

版權所有 (c) 2024, 您的名字 <您的郵箱>
許可在以下條件下使用、複製、修改和分發本軟件或其部分：
- 保留此版權聲明。
- 在分發的任何衍生作品中包含原始版權聲明。

無明示保證，包括但不限於適銷性、適合特定用途及不侵權的保證。在任何情況下，作者及其貢獻者均不對任何直接、間接、附帶、特殊、 EXEMPLARY 或後果性的損害承擔責任。