Mqttx MCP Sse Server

🚀 MQTTX SSE 服務器

MQTTX SSE 服務器實現了 Model-Context Protocol (MCP)，藉助 Server-Sent Events (SSE) 傳輸層，可在 MQTT 上執行各類操作，為 AI 助手與外部工具和服務的交互提供了強大支持。

✨ 主要特性

• 實現 MCP 協議版本 2024 - 11 - 05，緊跟協議標準。
• 採用 SSE（Server - Sent Events）作為傳輸層，保障即時消息傳遞。
• 支持通過 MCP 工具進行 MQTT 操作，包括連接到 MQTT 代理、訂閱 MQTT 主題以及發佈消息到 MQTT 主題。
• 能夠即時傳遞來自訂閱主題的消息。
• 具備多客戶端會話管理能力，高效處理多個客戶端的連接。

🚀 快速開始

先決條件

• Node.js（v14 或更高版本）
• npm

📦 安裝指南

# 克隆倉庫
git clone https://github.com/yourusername/mqttx-sse-server.git
cd mqttx-sse-server

# 安裝依賴項
npm install

運行服務器

npm start

服務器將在默認端口 4000 上運行。

💻 使用示例

配置 MQTTX

要將此 MCP 服務器與 MQTTX 一起使用，請在您的 MQTTX 設置中添加以下配置：

{
  "mcpServers": {
    "mqttx-server": {
      "url": "http://localhost:4000/mqttx/sse"
    }
  }
}

📚 詳細文檔

MCP 協議實現

此服務器實現了 Model - Context Protocol，包含以下組件：

• SSE 連接：建立持久連接以接收即時更新。
• JSON - RPC API：處理工具調用和響應，符合 MCP 規範。
• 工具接口：通過標準化的 MCP 工具提供 MQTT 功能。
• 會話管理：跟蹤客戶端會話及其 MQTT 連接。

📄 API 文檔

SSE 連接

建立一個用於接收服務器事件的持久連接。

GET /mqttx/sse

響應事件：

• endpoint：包含進行 JSON - RPC 調用的 URL。
• heartbeat：定期心跳以保持連接 alive。
• message：包含 JSON - RPC 響應。

JSON - RPC 命令

所有命令均發送到消息端點，使用您的會話 ID：

POST /mqttx/message?sessionId=xxx

初始化

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "initialize"
}

列出工具

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/list"
}

MQTT 連接

{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "tools/call",
  "params": {
    "name": "mqttConnect",
    "arguments": {
      "host": "broker.example.com",
      "port": 1883,
      "clientId": "mqttx-client"
    }
  }
}

MQTT 訂閱

{
  "jsonrpc": "2.0",
  "id": 4,
  "method": "tools/call",
  "params": {
      "name": "mqttSubscribe",
      "arguments": {
        "topic": "test/topic",
        "qos": 0
      }
  }
}

MQTT 發佈

{
  "jsonrpc": "2.0",
  "id": 5,
  "method": "tools/call",
  "params": {
      "name": "mqttPublish",
      "arguments": {
        "topic": "test/topic",
        "payload": "Hello MQTT!",
        "qos": 0,
        "retain": false
      }
  }
}