规则管理服务器

光标规则MCP服务器

一个MCP（模型上下文协议）服务器，从Git存储库中获取游标规则，使您能够在多个项目之间共享规则。

快速开始

1. 安装依赖项： npm安装

2. 使服务器可执行： chmod+x服务器.js

3. 创建 config.json: { “gitRepo”：https://github.com/your-username/your-rules-repo.git", “gitBranch”：“main”， “缓存TTL”：3600000 }

4. 测试服务器： node-server.js

5. 连接到光标：

   • 打开光标设置→ 特性→ MCP
   • 点击“+添加新MCP服务器”
   • 姓名： cursor-rules-server
   • 类型： stdio
   • 命令： node /absolute/path/to/cursor-rules-mcp/server.js

配置

编辑 config.json:

• gitRepo （必填）：包含规则的Git存储库URL
• gitBranch （可选）：分支名称（默认：“main”）
• cacheTTL （可选）：缓存持续时间（毫秒）（默认值：3600000=1小时）

Git存储库结构

服务器在以下位置查找规则（按顺序）：

1. .cursor/rules/ 目录
2. rules/ 目录
3. 根目录

规则文件应具有 .mdc 或 .md 扩展。

可用工具

• get_rule -按名称获取特定规则
• list_rules -列出所有可用规则
• get_all_rules -合并所有规则
• get_rule_readme -获取README文件
• refresh_rules -强制从Git刷新

可用提示

• apply_documentation_consistency -应用一致性规则
• validate_completeness -验证文档的完整性
• check_objective_alignment -检查物镜对准情况
• plan_phase -获取阶段规划指导
• review_jira_initiative -审查JIRA倡议
• review_jira_epic -回顾JIRA Epic

故障排除

服务器无法启动：

• 检查Node.js版本： node --version （需要18+）
• 验证 config.json 存在并且是有效的JSON
• 检查Git是否已安装： git --version
• 如果你看到 EACCES （权限被拒绝）错误，请使服务器可执行： chmod +x server.js

无法获取规则：

• 验证 gitRepo URL正确
• 测试访问： git clone <your-repo-url>
• 检查分支名称是否匹配 gitBranch 在配置中

未找到规则：

• 使用 list_rules 查看可用规则的工具
• 检查存储库结构是否与预期格式匹配
• 验证文件扩展名是否 .mdc 或 .md

缓存问题：

• 删除 cache/ 要清除缓存的目录
• 使用 refresh_rules 强制刷新工具