SUPOS

🚀 supOS MCP 服務器

supOS MCP 服務器基於 模型上下文協議 (MCP) 協議提供的 typescript-sdk 開發，支持任何遵循 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 服務器地址

✨ 主要特性

此服務器提供了一系列 supOS 開源 API，允許任何支持 MCP 協議的客戶端使用，為用戶提供便捷的主題信息查詢服務。

📦 安裝指南

系統要求

• 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（字符串）：搜索關鍵字
   • 輸出：符合條件的主題列表

📄 許可證

此項目在 Apache License 2.0 許可證下開源 - 請參閱 LICENSE 文件以獲取詳細信息。

🔚 總結

以上是使用此服務的完整指南。配置完成後，您可以在以下面板中看到相應服務和工具：

最終說明

supOS 社區版已集成由 CopilotKit 作者開源的 open-mcp-client，並內置了 mcp-server-supos 服務，支持 ts 版本的 agent。源代碼可訪問 supOS-CE-McpClient。