使用说明(Markdown 格式)
- 项目简介
- 该仓库实现了一个 MCP 服务器,用于向 MCP 客户端(如 LLM 应用)提供规则加载、工具执行和工作流指南等能力。服务器通过标准的 JSON-RPC 形式响应请求,支持列出可用工具、执行工具调用以及获取具体规则内容。
- 主要功能点
- 处理 MCP 请求与响应:实现 ListTools、CallTool 等请求的处理逻辑,按照 MCP 规范返回相应数据。
- 工具注册与执行:注册 fetch_workflow_guide、fetch_rule、list_available_rules 等工具,支持根据参数执行并返回规则内容。
- 规则与工作流获取:从本地 rules 目录读取 markdown 规则文件,提供规则元数据与内容。
- 本地数据源整合:通过本地规则仓库(rules 目录)作为数据源,支持 Just-In-Time 加载和按需检索。
- 标准传输方式:使用 stdio 传输,便于在开发环境中直接与命令行/管道进行集成。
- 日志与错误处理:在服务器内部进行详细日志输出,便于调试与运维。
- 安装步骤
- 依赖准备
- 需要 Node.js 环境,仓库内的 MCP 服务器代码使用 TypeScript/JavaScript 编写。
- 构建与安装
- 安装依赖并构建:在项目根目录执行 npm install,然后执行 npm run build。
- 将可执行入口链接到全局命令:npm link,使得命令 cursor-rules-mcp 可以在任意位置调用。
- 启动与使用
- 在本地运行启动后,服务器通过标准输入/输出进行通信(stdio 传输)。
- 服务器启动后即可供 MCP 客户端连接与调用工具。
- 服务器配置(MCP 客户端连接配置示例,非客户端必需的代码,仅供参考) 注:以下 JSON 配置用于 MCP 客户端在连接该 MCP 服务器时的描述信息,包含服务器名称、启动命令和参数。实际使用中,客户端不需要修改仓库内部代码,但需要将此信息用于连接配置。
{ "serverName": "cursor-engineering-rules", "command": "cursor-rules-mcp", "args": [] }
另外,若使用 Claude Desktop 等工具进行配置,参考示例配置为: { "mcpServers": { "cursor-engineering-rules": { "command": "cursor-rules-mcp" } // 注意:若需要传入额外参数,可在 "args" 字段中添加,例如 ["--config", "/path/to/config.json"] } }
- 基本使用方法
- 启动服务器后,MCP 客户端通过提供的 serverName 及 command 连接到服务器。
- 客户端可调用以下工具:
- fetch_workflow_guide:获取核心工作流指南及其内容
- fetch_rule:按 category/topic 获取特定规则(例如 languages/python)
- list_available_rules:列出所有可用的规则及其简要描述
- 返回结果通常包含规则的标题、描述、优先级和内容(markdown 格式的规则文本)
- 若需要,请将服务器路径(baseUrl)配置为本地 rules 目录,以便服务器能够读取本地规则文件
- 运行后端与集成要点
- 该 MCP 服务器实现使用本地规则库进行数据提供,因此确保 rules 目录存在且包含相应的 .mdc 文件(前后信息会被提取用于规则内容输出)。
- 客户端在调用 fetch_rule 时需提供 category 与 topic(如 languages/python、core/workflow 等),服务器会返回对应的规则内容及元数据。
信息
分类
开发者工具