supOS MCP Server

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Integrations

  • Provides tools to interact with supOS's API, enabling users to query topic tree structures and retrieve topic details from supOS models.

supOS MCP Server

本MCP服务器是基于 Model Context Protocol (MCP) 协议提供的 typescript-sdk 进行开发,可以让任何支持MCP协议的客户端使用它。

它提供了一系列supOS的open-api,例如:查询topic树结构,topic详情等。

支持的API

Tools

  1. get-model-topic-tree
    • 查询topic 树结构菜单数据
    • 输入:
      • key (string): Fuzzy search keyword for child nodes
      • showRec (boolean): Number of records to display
      • type (string): Search type: 1--Text search, 2--Tag search
    • 返回: topic 树结构菜单数据
  2. get-model-topic-detail
    • 获取某个topic详情
    • 输入:
      • topic (string): The topic path corresponding to the model
    • 返回: 某个topic详情

接下来跟随文档一起使用吧

开始使用

系统要求

  • Node.js

安装客户端

目前支持MCP协议的客户端已有很多,比如桌面端应用 Claude for Desktop,或者IDE的一些插件等(VSCodeCline 插件),想了解已支持的客户端可访问 Model Context Protocol Client

这里以 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>" } } } }
    • 其中 API_URL 是可访问的supOS社区版地址。API_KEY 可通过登录社区版后,进入 DataModeling -> 查看某个具体的topic详情 -> Data Operation -> Fetch,找到对应的ApiKey复制即可。

注意:以上配置MCP服务器是借助 npx 拉取 mcp-server-supos npm包并在本地运行的方式给客户端提供服务。但 npxWindows 系统下读取环境变量 env 配置时可能会出错,因此可以采用下面方式解决:

本地运行服务

以下两种方式选择一种即可:

  • 本地安装 mcp-server-supos,并通过node运行
  1. Install
npm install mcp-server-supos -g
  1. 找到安装的包路径,例如: "C://Users//<USER_NAME>//AppData//Roaming//npm//node_modules//mcp-server-supos//dist//index.js"
  2. 修改 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>" } } } }
  • 下载本仓库源码本地编译执行
  1. 复制仓库:
git clone https://github.com/FREEZONEX/mcp-server-supos.git
  1. 安装依赖
npm ci
  1. 编译
npm run build
  1. 修改 claude_desktop_config.json 的配置,并重启应用
{ "mcpServers": { "supos": { "command": "node", "args": [ "<本地项目地址>//dist//index.js" ], "env": { "SUPOS_API_KEY": "<API_KEY>", "SUPOS_API_URL": "<API_URL>" } } } }

结语

以上就是使用该服务的全部教程,配置成功后可在以下面板中看到对应的服务和工具等:

You must be authenticated.

A
security – no known vulnerabilities
F
license - not found
A
quality - confirmed to work

An MCP protocol server that provides access to supOS open APIs, allowing MCP-compatible clients to query topic tree structures and details.

  1. 支持的API
    1. Tools
  2. 开始使用
    1. 系统要求
    2. 安装客户端
    3. 本地运行服务
    4. 结语