supOS MCP Server

基本能力

产品定位

supOS MCP Server 是一个基于 MCP 协议的服务器，旨在为支持 MCP 协议的客户端提供 supOS 开放 API 服务。

核心功能

1. 查询主题树结构 (get-model-topic-tree)
2. 支持模糊搜索子节点关键字
3. 可设置显示记录数量

4. 支持文本搜索和标签搜索两种类型

5. 获取主题详情 (get-model-topic-detail)

6. 通过主题路径获取特定主题的详细信息

7. 获取主题实时数据 (get-topic-realtime-data)

8. 通过主题路径获取特定主题的实时数据

9. 获取所有主题实时数据 (get-all-topic-realtime-data)

10. 获取并分析所有主题的实时数据

适用场景

• 需要访问 supOS 数据的 MCP 协议客户端
• 需要实时监控 supOS 主题数据的应用
• 需要分析 supOS 数据模型的开发者

工具列表

1. get-model-topic-tree: 查询主题树结构菜单数据
2. get-model-topic-detail: 获取特定主题的详细信息
3. get-topic-realtime-data: 获取特定主题的实时数据
4. get-all-topic-realtime-data: 获取所有主题的实时数据

常见问题解答

• Windows 系统下 npx 可能无法正确读取环境变量配置，建议使用本地安装或源码编译方式运行
• 配置修改后需要重启应用才能生效

使用教程

使用依赖

• Node.js

安装教程

1. 通过 npm 全局安装:

npm install mcp-server-supos -g

1. 或者通过源码安装:

git clone https://github.com/FREEZONEX/mcp-server-supos.git
cd mcp-server-supos
npm ci
npm run build

调试方式

1. 配置客户端(如 Claude for Desktop)的 claude_desktop_config.json 文件
2. 添加以下配置并重启应用:

{
  "mcpServers": {
    "supos": {
      "command": "node",
      "args": [
        "<本地安装路径或项目路径>//dist//index.js"
      ],
      "env": {
        "SUPOS_API_KEY": "<API_KEY>",
        "SUPOS_API_URL": "<API_URL>",
        "SUPOS_MQTT_URL": "<MQTT_URL>"
      }
    }
  }
}

1. 确保环境变量配置正确:
2. API_URL: supOS 社区版可访问地址
3. API_KEY: 登录社区版后获取
4. MQTT_URL: 从 UNS -> MqttBroker -> Listeners 获取

许可证

该项目遵循 Apache-2.0 开源许可条款，请参阅 Apache-2.0 了解完整条款。