Orderly Network MCP 服务器

使用说明

• 项目简介
  • 该仓库实现了一个用来为大型语言模型提供统一上下文和功能的后端服务器，遵循模型上下文协议（MCP），能够托管资源、注册工具、渲染 prompts，并通过 JSON-RPC 与客户端进行通信。
• 主要功能点
  • 资源管理：提供可查询的资源集，支持模糊搜索与分页查询。
  • 工具注册与执行：列出可用工具，按名称触发实现，返回统一结构的数据。
  • Prompts 处理：提供和渲染 Prompt 模板的能力，帮助设计多种交互模式。
  • 会话与能力声明：服务器端维护会话信息和能力声明。
  • 多传输协议支持：内置 Stdio 模式（本地客户端）与 HTTP/WebSocket 模式（托管部署），便于不同部署场景使用。
  • JSON-RPC 通信：统一的请求/响应格式，便于 LLM 客户端/代理对接。
• 安装步骤
  • 需求前提：Node.js 18+、Yarn/NPM、TypeScript 相关工具链。
  • 安装依赖并构建
    • 安装依赖并构建即可得到 dist 目录下的执行文件。
  • 两种运行模式
    • Stdio 模式（默认，本地 MCP 客户端使用）
      • 启动：yarn start
      • 客户端配置示例（由 MCP 客户端使用以连接本服务器的 stdio 输送）请参考 README 的配置示例。
    • HTTP 模式（ hosted 部署）
      • 启动：yarn start:http
      • 服务端将监听 3000 端口，MCP 端点地址为 http://localhost:3000/mcp
• 服务器配置（MCP 客户端所需配置） 说明：以下配置用于 MCP 客户端启动时，指明要启动的 MCP 服务器及其启动参数。具体字段含义如下：
  • serverName：服务器的唯一名称，便于区分多服务实例。
  • command：启动服务器的命令。
  • args：启动命令的参数数组，通常指向打包后的入口文件路径（相对 dist）。
  • transport（可选）：传输模式，stdio 表示使用标准输入输出，http 表示 HTTP/REST 模式。
  • 说明：MCP 客户端并不需要其它实现细节，只需知道如何启动服务器即可建立连接。
  1. stdio（默认本地连接） { "serverName": "orderly-network", "command": "node", "args": ["dist/index.js"], "transport": "stdio" }
  2. http（托管部署，HTTP 端点） { "serverName": "orderly-network-http", "command": "node", "args": ["dist/http-server.js"], "transport": "http", "port": 3000 }
• 基本使用方法
  • 进入 stdio 模式后，LLM 客户端通过 JSON-RPC 与 MCP 服务端进行交互，获取资源、调用工具、获取 Prompts 等。
  • 在 HTTP 模式下，LLM 客户端通过 POST 请求向 /mcp 提交 JSON-RPC 请求，服务端返回标准 JSON-RPC 响应。
  • 数据获取与调用路径示例（简述）：
    • 调用资源：读取 / 查询资源
    • 调用工具：执行 search_orderly_docs、get_sdk_pattern 等工具
    • 获取 Prompts：获取并渲染相应的 Prompt 模板
  • 注意事项
    • 部署时请根据实际网络环境配置正确的端口与跨域策略。
    • 数据源为仓库内置的 src/data/ 及 src/data/resources，数据会在 regeneration 时更新。