article
README
🚀 supOS MCP 服务器
supOS MCP 服务器基于 Model Context Protocol (MCP) 协议的 typescript-sdk 开发,为符合 MCP 协议的客户端提供支持。它开放了一系列 supOS 的 API,可用于查询主题树结构、获取主题详情等操作。
✨ 主要特性
- 基于 MCP 协议的
typescript-sdk开发,具备广泛的兼容性,支持任何符合 MCP 协议的客户端使用。 - 提供丰富的 supOS 开放 API,满足多样化的业务需求。
📦 安装指南
系统要求
- Node.js
安装客户端
目前,有多种支持 MCP 协议的客户端可供选择,例如桌面端应用 Claude for Desktop 或一些 IDE 插件(如 VSCode 的 Cline 插件)。若想了解所有已支持的客户端,请访问 Model Context Protocol Client。
下面以 Claude for Desktop 为例进行安装说明:
- 下载 Claude for Desktop。
- 为
Claude for Desktop配置 MCP 服务器。
配置步骤
- 基于
typescript-sdk的安装方式
npm install typescript-sdk
- 运行示例代码
const { supOS } = require('typescirpt-sdk');
const client = new supOS.MCPClient({
key: 'your_api_key',
secret: 'your_api_secret'
});
await client.connect();
console.log('连接成功');
💻 使用示例
支持的 API
工具
get-model-topic-tree- 功能:查询主题树结构菜单数据
- 输入参数:
key(字符串):子节点的模糊搜索关键字showRec(布尔值):显示记录的数量type(字符串):搜索类型,1 表示文本搜索,2 表示标签搜索
- 返回值:主题树结构菜单数据
get-model-topic-detail- 功能:获取某个主题的详细信息
- 输入参数:
topic(字符串):对应模型的主题路径
- 返回值:某个主题的详细信息
get-topic-realtime-data- 功能:获取某个主题的实时数据
- 输入参数:
topic(字符串):对应模型的主题路径
- 返回值:某个主题的实时数据
get-all-topic-realtime-data- 功能:获取所有主题的实时数据并进行分析
- 返回值:所有主题的实时数据
使用说明
基础用法
- 创建 MCP 客户端实例
const { MCPClient } = require('typescript-sdk');
const client = new MCPClient({
key: 'your_api_key',
secret: 'your_api_secret'
});
- 连接到 MCP 服务器
await client.connect();
console.log('已连接到 MCP 服务器');
- 调用 API 方法
- 获取主题树结构
const tree = await client.getmodeltopicTree();
console.log(tree);
- 获取某个主题的详细信息
const detail = await client.getmodeltopicDetail('your_topic_path');
console.log(detail);
结语
以上就是使用该服务的全部教程,配置成功后可以在以下面板中看到对应的服务和工具等:
supOS 社区版 已集成 CopilotKit 作者开源的 open-mcp-client,并内置了 mcp-server-supos 服务,且支持 TypeScript 版本的代理。源码可访问 supOS-CE-McpClient。
微信扫一扫