RC Engine MCP 服务器端框架
使用说明
- 项目简介 RC Engine MCP 服务器端框架是一个完整的 MCP 服务器实现,负责托管资源、注册和执行工具、定义并渲染 Prompt 模板,并通过 JSON-RPC 与客户端进行通信。它还提供多传输协议支持、会话管理、权限与能力声明,以及便于在 IDE 中集成的连接机制。
- 主要功能点
- MCP 核心功能:注册工具、读取资源、获取并渲染 Prompts,响应 JSON-RPC 请求。
- 资源与工具管理:内置工具集合覆盖 Pre-RC、RC、Post-RC、Traceability 等域,支持Graceful 增删与版本管理。
- 会话与鉴权:会话管理、令牌/权限机制,以及对客户端的能力声明。
- 多传输协议支持:支持 Stdio、SSE、WebSocket 等传输方式以满足不同客户端需求。
- IDE 集成:提供在 IDE 配置的示例,方便将 MCP 服务器接入到 Claude Code、Cursor、Windsurf、VS Code 等环境。
- 安全与可扩展性:对输入进行 guarding、输入大小限制、幂等工具包装,确保多租户/多用户场景的安全性与可扩展性。
- 安装步骤
- 安装 Node.js >= 18。
- 获取源码并安装依赖:在项目根目录执行 npm install。
- 构建项目:执行 npm run build,生成 dist 目录。
- 运行 MCP 服务器:使用 Node 启动 dist/index.js(或按实际部署路径执行 node dist/index.js)。
- 根据需要,在 IDE 中配置 MCP 服务器连接(参见下一节的示例配置说明)。
- 服务器配置(供 MCP 客户端使用的配置信息)
服务器配置用于 MCP 客户端连接 MCP 服务器,字段示例(以 JSON 形式描述,便于粘贴到配置文件中阅读):
{
"serverName": "rc-engine",
"command": "node",
"args": ["/absolute/path/to/rc-engine/dist/index.js"],
"transport": "stdio",
"description": "RC Engine MCP 服务器实例,用于提供资源、工具和 Prompts 的上下文服务"
}
说明:
- serverName: MCP 服务器的唯一标识名称,客户端通过该名称识别目标服务器。
- command: 启动服务器的命令,一般为 node。
- args: 启动参数,需指向编译产物 dist/index.js 的绝对路径。
- transport: 指定与客户端的传输层,常见值包括 stdio、sse、websocket(按客户端实现选择)。
- description: 对该服务器的简要描述,便于在 IDE 或管理平台中查看。
- 基本使用方法
- 在 IDE 中配置连接:将上述配置添加到 MCP 客户端设置中,确保 serverName 与实际启动的服务匹配。
- 启动与连接:先在服务器上启动 MCP 服务,再在 IDE 中通过配置连接到服务器。
- 调用工具与读取资源:通过 MCP 客户端的统一接口调用服务器注册的 Tools、获取 Resources、执行 Prompts 等。
- 监控与扩展:利用服务器暴露的日志、WebSocket 通道和 REST 端点监控工具状态与管线进展,按需扩展新的域工具。
- 安全性与合规性:结合 guard-wrapping 及输入校验,确保在多租户场景下的安全性与可控性。