MCP 服务器

supOS MCP Server

一个MCP协议服务器，提供对supOS开放API的访问，允许兼容MCP的客户端查询主题树结构和详细信息。

Tools

get-model-topic-tree

get-model-topic-detail

README

English | 中文

supOS MCP 服务器

此 MCP 服务器基于模型上下文协议 (MCP) 协议提供的 typescript-sdk 开发，允许任何支持 MCP 协议的客户端使用它。

它提供了一系列 supOS 开放 API，例如查询主题树结构、主题详情等。

支持的 API

工具

get-model-topic-tree
- 查询主题树结构菜单数据
- 输入:
  - key (string): 子节点的模糊搜索关键字
  - showRec (boolean): 要显示的记录数
  - type (string): 搜索类型：1--文本搜索，2--标签搜索
- 返回: 主题树结构菜单数据
get-model-topic-detail
- 获取特定主题的详细信息
- 输入:
  - topic (string): 模型对应的主题路径
- 返回: 特定主题的详细信息
get-topic-realtime-data
- 获取特定主题的实时数据
- 输入:
  - topic (string): 模型对应的主题路径
- 返回: 特定主题的实时数据
get-all-topic-realtime-data
- 获取和分析所有主题的实时数据
- 返回: 所有主题的实时数据

让我们按照文档开始使用它

入门指南

系统要求

Node.js

安装客户端

目前，有许多客户端支持 MCP 协议，例如桌面应用程序（如 Claude for Desktop）或 IDE 插件（如 VSCode 的 Cline 插件）。要了解支持的客户端，请访问模型上下文协议客户端。

这里我们以 Claude for Desktop 为例。

下载 Claude for Desktop。
为 Claude for Desktop 配置所需的 MCP 服务器。
- 在文本编辑器中打开您的 Claude for Desktop 配置：~/Library/Application Support/Claude/claude_desktop_config.json。
- 您也可以通过在 File -> Setting -> Developer 中点击 Edit Config 来找到此配置文件位置：

打开配置文件后，将以下内容添加到 claude_desktop_config.json 并重新启动应用程序： 注意：每次修改此配置文件后，都需要重新启动应用程序才能使更改生效。

{
  "mcpServers": {
    "supos": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-server-supos"
      ],
      "env": {
        "SUPOS_API_KEY": "<API_KEY>",
        "SUPOS_API_URL": "<API_URL>",
        "SUPOS_MQTT_URL": "<MQTT_URL>"
      }
    }
  }
}

- 其中 API_URL 是 supOS 社区版的可访问地址。 API_KEY 可以通过登录社区版，进入 DataModeling -> View specific topic details -> Data Operation -> Fetch 并复制相应的 ApiKey 来找到。 MQTT_URL 可以通过访问 UNS -> MqttBroker -> Listeners 来查看可订阅的地址。

注意：上述 MCP 服务器的配置使用 npx 来拉取 mcp-server-supos npm 包并在本地运行它，以便为客户端提供服务。但是，npx 在 Windows 系统上可能存在读取环境变量 env 配置的问题，因此可以采用以下解决方案：

在本地运行服务

选择以下两种方法之一：

在本地安装 mcp-server-supos 并通过 node 运行它

安装

npm install mcp-server-supos -g

找到已安装的包路径，例如："C://Users//<USER_NAME>//AppData//Roaming//npm//node_modules//mcp-server-supos//dist//index.js"
修改 claude_desktop_config.json 中的配置并重新启动应用程序

{
  "mcpServers": {
    "supos": {
      "command": "node",
      "args": [
        "C://Users//<USER_NAME>//AppData//Roaming//npm//node_modules//mcp-server-supos//dist//index.js"
      ],
      "env": {
        "SUPOS_API_KEY": "<API_KEY>",
        "SUPOS_API_URL": "<API_URL>",
        "SUPOS_MQTT_URL": "<MQTT_URL>"
      }
    }
  }
}

在本地下载并编译存储库源代码

克隆存储库：

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

安装依赖项

npm ci

构建

npm run build

修改 claude_desktop_config.json 中的配置并重新启动应用程序

{
  "mcpServers": {
    "supos": {
      "command": "node",
      "args": [
        "<local project path>//dist//index.js"
      ],
      "env": {
        "SUPOS_API_KEY": "<API_KEY>",
        "SUPOS_API_URL": "<API_URL>",
        "SUPOS_MQTT_URL": "<MQTT_URL>"
      }
    }
  }
}