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。