English |中文

supOS MCP 服务器

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

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

支持的 API

工具

1. get-model-topic-tree

   • 查询主题树结构菜单数据

   • 输入：

     • key （字符串）：子节点的模糊搜索关键字

     • showRec （布尔值）：要显示的记录数

     • type （字符串）：搜索类型：1--文本搜索，2--标签搜索

   • 返回：主题树结构菜单数据

2. get-model-topic-detail

   • 获取特定主题的详细信息

   • 输入：

     • topic （字符串）：模型对应的主题路径

   • 返回：特定主题的详细信息

3. get-topic-realtime-data

   • 获取特定主题的实时数据

   • 输入：

     • topic （字符串）：模型对应的主题路径

   • 返回：特定主题的实时数据

4. get-all-topic-realtime-data

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

   • 返回：所有主题的实时数据

5. get-topic-history-data-by-graphql

   • 从 graphql 获取特定主题的历史数据

   • 输入：

     • topic （字符串）：模型对应的主题路径

     • limit （number）：限制记录数

     • startTime （字符串）：ISO 8601 格式的开始时间，例如 2025-04-13T00:00:00Z。若未指定，则默认为当前时间前一周

     • endTime ：ISO 8601 格式的结束时间，例如 2025-04-20T23:59:59Z。若未指定，则默认为当前时间。

   • 返回：特定主题的历史数据

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

Related MCP server: supabase-mcp

入门

系统要求

• Node.js

安装客户端

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

这里我们将使用Claude for Desktop作为示例。

• 下载Claude 桌面版。

• 为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``API_KEYsupOS 社区版可访问地址MQTT_URL可通过登录社区版，进入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 运行

1. 安装

npm install mcp-server-supos -g

2. 找到安装的包路径，例如： "C://Users//<USER_NAME>//AppData//Roaming//npm//node_modules//mcp-server-supos//dist//index.js"

3. 修改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>"
      }
    }
  }
}

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

1. 克隆存储库：

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

2. 安装依赖项

npm ci

3. 建造

npm run build

4. 修改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>"
      }
    }
  }
}

结论

以上就是该服务的完整使用教程，配置成功后，可以在以下面板中看到相应的服务和工具：

通过 Smithery 安装

要通过Smithery自动为 Claude Desktop 安装 supOS MCP 服务器：

npx -y @smithery/cli install @FREEZONEX/mcp-server-supos --client claude

最后说明

supOS 社区版集成了CopilotKit作者开源的open-mcp-client ，并内置了mcp-server-supos服务，支持 ts 版本agent 。源代码可访问supOS-CE-McpClient 。

执照

该项目根据 Apache License 2.0 获得许可 - 有关详细信息，请参阅LICENSE文件。