项目简介
本MCP服务器基于 Model Context Protocol (MCP) 协议,旨在为支持MCP协议的客户端(如 Claude for Desktop)提供便捷的 supOS API 访问能力。通过注册工具的方式,客户端可以调用 supOS 的开放接口,获取例如主题树结构、主题详情等数据,从而扩展 LLM 应用的上下文信息来源和功能。
主要功能点
- 提供 supOS 数据访问工具: 通过 MCP 协议向客户端暴露 supOS 平台的开放 API,目前包括:
- 'get-model-topic-tree': 查询 supOS 中的主题树结构,支持关键词模糊搜索和按类型搜索。
- 'get-model-topic-detail': 获取指定主题的详细信息。
- 标准 MCP 服务器实现: 遵循 MCP 协议规范,使用 JSON-RPC 通信,支持 Stdio 传输协议,能够与任何兼容 MCP 协议的客户端进行交互。
- 易于配置和部署: 可以通过 npm 包快速安装,也支持本地源码编译运行,配置简单,方便集成到现有 LLM 应用工作流中。
安装步骤
- 安装 Node.js: 确保你的系统已安装 Node.js 运行环境。
- 全局安装 mcp-server-supos: 打开终端,运行以下命令进行全局安装:
npm install mcp-server-supos -g
服务器配置
要将 'mcp-server-supos' 配置为 MCP 服务器,你需要编辑 MCP 客户端的配置文件。以 'Claude for Desktop' 为例,你需要修改 'claude_desktop_config.json' 文件。
在 'claude_desktop_config.json' 文件的 'mcpServers' 字段中添加一个新的服务器配置项,例如命名为 'supos'。配置内容如下:
{ "mcpServers": { "supos": { "command": "npx", "args": [ "-y", "mcp-server-supos" ], "env": { "SUPOS_API_KEY": "<请替换为你的 supOS API Key>", "SUPOS_API_URL": "<请替换为你的 supOS API URL,例如:https://supos-demo.supos.app/>" } } } }
配置参数说明:
- 'server name': 'supos' (服务器名称,可以自定义,用于在客户端中标识该服务器)
- 'command': 'npx' (启动命令,用于执行 npm 包)
- 'args': '["-y", "mcp-server-supos"]' (命令参数,'-y' 表示自动确认安装 npm 包,'mcp-server-supos' 是要执行的包名)
- 'env': 环境变量配置,用于传递 API 密钥和 API URL 给服务器程序。
- 'SUPOS_API_KEY': 请务必替换为你在 supOS 平台获取的 API Key。 你可以在 supOS 社区版 (https://supos-demo.supos.app/) 登录后,进入 'DataModeling -> 查看某个具体的topic详情 -> Data Operation -> Fetch' 找到 API Key。
- 'SUPOS_API_URL': 请务必替换为你的 supOS API 服务的 URL 地址。 例如,supOS 社区版地址为 'https://supos-demo.supos.app/'。
注意:
- 每次修改 'claude_desktop_config.json' 文件后,必须重启 MCP 客户端 (Claude for Desktop) 应用 才能使配置生效。
- 如果在 Windows 系统下使用 'npx' 遇到环境变量读取问题,可以考虑使用 本地运行服务 的方式,参考仓库 README.md 文档获取更多信息。
基本使用方法
配置完成后,在支持 MCP 协议的客户端中 (例如 Claude for Desktop),你将能够看到名为 'supos' 的服务器以及其提供的工具 'get-model-topic-tree' 和 'get-model-topic-detail'。
在客户端中,你可以像调用其他工具一样使用这些 supOS 工具。例如,在 Claude for Desktop 中,你可以通过自然语言指令或工具调用面板来触发这些工具,并传入相应的参数 (例如 'topic' 名称或查询 'key' 词)。工具执行后,返回的 supOS 数据将作为上下文信息提供给 LLM 模型使用。
具体使用方式取决于 MCP 客户端的功能和界面,请参考你所使用的客户端的文档。
信息
分类
网页与API