Mqttx MCP Sse Server

🚀 MQTTX SSE サーバー

Model-Context Protocol (MCP) を実装したサーバーで、Server-Sent Events (SSE) 伝送層を介して MQTT 上で操作を実行できるようにします。

✨ 主な機能

• 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（MCP）は、AI アシスタントが外部ツールやサービスとやり取りできるようにする標準化されたプロトコルです。このサーバーは MCP 仕様を実装し、SSE（Server-Sent Events）を伝送層として使用して、MQTT ブローカー接続機能を提供します。

MCP プロトコルの実装

このサーバーは Model-Context Protocol を実装しており、以下のコンポーネントを含みます。

• SSE 接続：リアルタイム更新を受信するための永続的な接続を確立
• JSON-RPC API：MCP 仕様に準拠したツール呼び出しと応答を処理
• ツールインターフェース：標準化された MCP ツールを通じて MQTT 機能を提供
• セッション管理：クライアントセッションとその MQTT 接続を追跡

💻 使用例

基本的な使用法

SSE 接続

サーバーイベントを受信するための永続的な接続を確立します。

GET /mqttx/sse

応答イベント：

• endpoint：JSON-RPC 呼び出しを行う URL を含む
• heartbeat：接続を維持するための定期的なハートビート
• 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
      }
  }
}