Thingsboard MCP

🚀 ThingsBoard MCP Server

ThingsBoard MCP Serverは、LLMやAIエージェントがThingsBoard IoTプラットフォームと対話するための自然言語インターフェースを提供します。自然言語でデバイスやテレメトリデータの操作、分析を行うことができます。

🚀 クイックスタート

1. MCPクライアントを設定する：MCPクライアントの設定にThingsBoard MCPサーバーを追加します（クライアント設定を参照）
2. 自然言語で操作を開始する：MCPクライアントを通じて、ThingsBoardインスタンスとの対話を開始します

✨ 主な機能

エンティティ操作

• デバイス：デバイスの詳細、認証情報、プロファイルを表示し、デバイスの関係を管理します
• アセット：アセット、アセットプロファイル、アセットの関係を表示し、管理します
• 顧客：顧客情報、タイトルを取得し、顧客の関係を管理します
• ユーザー：ユーザー、トークン、アクティベーションリンク、ユーザーの割り当てを管理します

テレメトリ管理

• 属性アクセス：任意のエンティティの属性キーと値をスコープごとに取得します
• 時系列アクセス：様々な集計オプションで時系列データを取得します
• テレメトリの挿入/更新：属性または時系列データをオプションのTTL設定で保存します

関係

方向ベースのクエリでエンティティ間の関係を探索し、ナビゲートします。

アラーム

特定のエンティティのアラーム、アラームタイプ、重大度情報を取得します。

管理

• システム設定：管理設定にアクセスし、管理します
• セキュリティ設定：セキュリティポリシーとJWT設定を表示します
• バージョン管理：リポジトリと自動コミット設定を管理します
• システム情報：更新を確認し、使用統計を取得します

📦 インストール

このMCPサーバーは、ThingsBoard IoT PlatformまたはThingsBoard Edgeと連携します。インストールには、ThingsBoardインスタンスまたはEdgeのURLと有効な認証情報が必要です。

ThingsBoardアカウント

MCPサーバーをインストールする前に、以下のものが必要です：

1. ThingsBoardまたはEdgeインスタンスへのアクセス
2. 十分な権限を持つユーザーアカウント
3. このアカウントのユーザー名とパスワード

Dockerイメージ

最も簡単な開始方法は、Docker Hubから事前構築されたDockerイメージを使用することです。

サーバーモード

ThingsBoard MCPサーバーは、2つの異なるモードで実行できます：

• STDIOモード（標準入出力）：サーバーは標準入出力ストリームを介して直接通信します
• SSEモード（サーバー送信イベント）：サーバーはクライアントが接続するHTTPサーバーとして実行されます

STDIOモードでの実行（デフォルト）

STDIOモードでは、stdinを開いたままにするために-iフラグを含める必要があります：

docker pull thingsboard/mcp
docker run --rm -i -e THINGSBOARD_URL=<your_thingsboard_url> -e THINGSBOARD_USERNAME=<your_username> -e THINGSBOARD_PASSWORD=<your_password> thingsboard/mcp

SSEモードでの実行

SSEモードでは、-pフラグを使用してポート8000を公開し、デフォルト設定を明示的にオーバーライドする必要があります：

docker pull thingsboard/mcp
docker run --rm -p 8000:8000 -e THINGSBOARD_URL=<your_thingsboard_url> -e THINGSBOARD_USERNAME=<your_username> -e THINGSBOARD_PASSWORD=<your_password> -e SPRING_AI_MCP_SERVER_STDIO=false -e SPRING_WEB_APPLICATION_TYPE=servlet thingsboard/mcp

ソースからのビルド

ソースからJARファイルをビルドし、ThingsBoard MCPサーバーを直接実行することもできます。

前提条件

• Java 17以上
• Maven 3.6以上

ビルド手順

1. このリポジトリをクローンします
2. プロジェクトをビルドします：

mvn clean install -DskipTests

3. JARファイルはtargetフォルダに生成されます：

./target/thingsboard-mcp-server-1.0.0.jar

4. JARファイルを使用してサーバーを実行します：

# STDIOモード
java -jar ./target/thingsboard-mcp-server-1.0.0.jar

# SSEモード
java -Dspring.ai.mcp.server.stdio=false Dspring.main.web-application-type=servlet -jar ./target/thingsboard-mcp-server-1.0.0.jar

💻 使用例

基本的な使用法

MCPクライアントを設定し、自然言語でThingsBoardインスタンスと対話することができます。例えば、以下のような質問をすることができます：

Get my devices of type 'Air Quality Sensor'

これにより、構造化された結果が返されます。

高度な使用法

時系列データの解析や保存などの高度な操作も可能です。例えば、以下のような操作を行うことができます：

• 時系列データのシミュレーションや保存を要求する
• 時系列データを分析して異常、急増、またはデータギャップを見つける

📚 ドキュメント

クライアント設定

MCPクライアントが起動するときにサーバーをコンテナとして起動するには、クライアントの設定に適切な構成を追加する必要があります。

Docker設定

Dockerイメージを使用する場合は、claude_desktop_config.jsonに以下の構成を使用します：

{
  "mcpServers": {
    "thingsboard": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "THINGSBOARD_URL",
        "-e",
        "THINGSBOARD_USERNAME",
        "-e",
        "THINGSBOARD_PASSWORD",
        "-e",
        "LOGGING_PATTERN_CONSOLE",
        "thingsboard/mcp"
      ],
      "env": {
        "THINGSBOARD_URL": "<thingsboard_url>",
        "THINGSBOARD_USERNAME": "<thingsboard_username>",
        "THINGSBOARD_PASSWORD": "<thingsboard_password>",
        "LOGGING_PATTERN_CONSOLE": ""
      }
    }
  }
}

バイナリ設定

ソースからJARファイルをビルドした場合は、claude_desktop_config.jsonに以下の構成を使用します：

{
  "mcpServers": {
    "thingsboard": {
      "command": "java",
      "args": [
        "-jar",
        "/absolute/path/to/thingsboard-mcp-server-1.0.0.jar"
      ],
      "env": {
        "THINGSBOARD_URL": "<thingsboard_url>",
        "THINGSBOARD_USERNAME": "<thingsboard_username>",
        "THINGSBOARD_PASSWORD": "<thingsboard_password>",
        "LOGGING_PATTERN_CONSOLE": ""
      }
    }
  }
}

環境変数

MCPサーバーがThingsBoardインスタンスに接続するためには、以下の環境変数が必要です：

これらの変数は、以下のいずれかの方法で設定できます：

• Dockerコマンドラインを使用して-eフラグで直接設定する
• MCPクライアントの設定のenv構成ブロックを通じて設定する

利用可能なツール

ThingsBoard MCPサーバーは、自然言語コマンドで使用できる幅広いツールを提供します。これらのツールはカテゴリ別に整理されています。

デバイスツール

アセットツール

顧客ツール

ユーザーツール

アラームツール

エンティティグループツール

関係ツール

テレメトリツール

管理ツール

📄 ライセンス

このプロジェクトは、Apache 2.0ライセンスの下でライセンスされています。詳細については、ライセンスファイルを参照してください。