SUPOS

🚀 supOS MCP サーバー

この MCP サーバーは、モデルコンテキストプロトコル (MCP) プロトコルが提供する typescript-sdk を基に開発されており、MCP プロトコルをサポートする任意のクライアントが利用できます。

このサーバーは、supOS の一連のオープンソース API を提供しており、例えばトピックツリー構造の照会やトピックの詳細情報の取得などが可能です。

✨ 主な機能

• モデルコンテキストプロトコル (MCP) をサポートする任意のクライアントが利用可能
• supOS のオープンソース API を通じて、トピックツリー構造やトピック詳細情報の照会などが可能

📦 インストール

システム要件

• Node.js (推奨バージョン 14.0 以上)

インストール手順

1. リポジトリをクローンします:

git clone https://github.com/FREEZONEX/mcp-server-supos.git

2. 依存関係をインストールします:

npm ci

3. プロジェクトをビルドします:

npm run build

4. サーバーを起動します:

npm start

設定説明

サービスを起動する前に、以下の環境変数が正しく設定されていることを確認してください:

• SUPOS_API_KEY: supOS API のアクセスキー
• SUPOS_API_URL: supOS API のアドレス
• SUPOS_MQTT_URL: supOS MQTT サーバーのアドレス

💻 使用例

基本的な使用法

// トピックツリー構造を照会する
const result = await getmodeltopicTree();

// 単一のトピックを照会する
const result = await getmodeltopic('your-topic-id');

// トピックを検索する
const result = await searchtopics('search-keyword');

📚 ドキュメント

サポートされる API

ツール

1. get-model-topic-tree

   • トピックツリー構造のメニューデータを照会します。
   • 入力:
     • key (文字列): 子ノードの曖昧検索キーワード
     • showRec (ブール値): レコード数を表示するかどうか
     • type (文字列): タイプ（オプション、デフォルトは "TREE"）
   • 出力: トピックツリー構造のデータ

2. get-model-topic

   • 単一のトピックの詳細情報を照会します。
   • 入力:
     • id (文字列): トピック ID
   • 出力: トピックの詳細情報

3. search-topics

   • トピックを検索します。
   • 入力:
     • query (文字列): 検索キーワード
   • 出力: 条件に一致するトピックのリスト

結論

以上がこのサービスの使用方法の完全なガイドです。設定が完了したら、以下のパネルで対応するサービスとツールを確認できます:

最後の説明

supOS コミュニティ版には、CopilotKit の作者によってオープンソース化された open-mcp-client が統合されており、mcp-server-supos サービスが組み込まれています。ts バージョンの agent もサポートしています。ソースコードは supOS-CE-McpClient からアクセスできます。

📄 ライセンス

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