Rystem 模型上下文协议服务器

使用说明

  • 项目简介
    • 这是一个 Rystem 项目中的 MCP 服务器实现,能够向行为于 LLM 的客户端提供资源、工具和提示模板等上下文信息,并通过 JSON-RPC 调用进行交互,支持本地开发环境。
  • 主要功能点
    • 自带健康检查与 MCP 服务入口,便于快速验证服务器可用性
    • 读取本地 manifest(mcp-manifest.json)并注册工具、资源与提示模板
    • 工具(Tools)以 Markdown 文档形式提供实现内容,通过 REST-like JSON-RPC 交互返回内容
    • 资源(Resources)以 Markdown 文档形式提供上下文数据,可按 URI 读取
    • 提示(Prompts)以 Markdown 文本作为输入模板,支持参数替换
    • 支持本地开发的传输,使用 Streamable HTTP Transport 实现 JSON-RPC over HTTP
    • 提供健康接口与 MCP 主入口页面
  • 安装步骤
    • 将仓库中的相关 MCP 服务代码部署到本地开发环境(Node.js/TypeScript 环境)
    • 安装依赖并启动 MCP 服务
    • 入口为本地服务器(示例端口默认 3000),可通过 /mcp 进行 MCP 请求测试
  • 服务器配置(供 MCP 客户端连接的参考 JSON 配置) { "serverName": "rystem", "command": "npm", "args": ["run", "dev:api"] } 说明:
    • serverName 是 MCP 服务器在客户端侧的标识;可按实际部署名称命名
    • command 与 args 指定启动服务器的命令及参数,以便 MCP 客户端能够执行相应的连接与测试
    • 该配置仅用于客户端示例,实际部署可能需要适配不同的运行环境(如容器、云端函数等)
  • 基本使用方法
    • 启动:在本地环境执行上述启动命令,确保端口可用(默认 3000)
    • 访问:打开 http://localhost:3000/mcp 获取 MCP 服务入口信息并发送 MCP 请求
    • 测试:使用 MCP Inspector 或直接向 http://localhost:3000/mcp 发送 JSON-RPC 请求进行交互,例如初始化、查询工具、读取资源、执行工具等
    • 运行时扩展:如果需要扩展工具、资源或 prompts,可以在 public/mcp 目录下添加相应的 md 文档与 manifest 配置,MCP 服务会在下次请求时注册并暴露新项

服务器信息