Style Guidelines

🚀 MCPRules - 编程规范管理服务器

MCPRules 是一个强大的模型上下文协议（MCP）服务器，用于管理和提供编程指南与规则。它能与开发工具集成，助力项目实现一致的编码标准。

✨ 主要特性

• 规则管理
  • 可通过MCP工具访问规则。
  • 支持按类别过滤规则。
  • 既支持本地托管规则，也支持GitHub托管规则。
  • 采用结构化的规则格式，包含类别和键值对。
• 灵活存储
  • 支持本地文件系统。
  • 可与GitHub仓库集成。
  • 基于Markdown定义规则。
• 类别组织
  • 涵盖核心编程原则。
  • 包含代码风格和格式相关内容。
  • 有语言特定指南。
  • 涉及项目管理规则。
  • 具备操作系统特定规则。

📦 安装指南

1. 克隆仓库

   git clone https://github.com/yourusername/MCPRules.git
   cd MCPRules/rules-server
   

2. 安装依赖项

   npm install
   

3. 构建服务器

   npm run build
   

4. 配置环境变量

   export RULES_FILE_PATH=/path/to/your/rules.md
   # 可选，用于私有GitHub仓库
   export GITHUB_TOKEN=你的_github_token
   

📚 详细文档

配置

对于VSCode Cline扩展

位置: ~/Library/Application Support/Windsurf/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json

{
"mcpServers": {
"rules": {
"command": "node",
"args": ["/path/to/rules-server/build/index.js"],
"disabled": false,
"alwaysAllow": []
}
}
}

对于Claude Desktop

位置: ~/Library/Application Support/Claude/claude_desktop_config.json

使用方法

可用工具

• 获取规则

  // 获取所有规则或按类别过滤
  {
  "category": "optional-category-name"
  }
  

• 获取类别

  // 列出所有可用的规则类别
  {}
  

规则格式

规则存储在Markdown文件中，具有以下结构：

#Category
key: value

开发

• 监控模式

  npm run watch
  

• 调试

  npm run inspector
  

贡献

1. 叉仓库
2. 创建功能分支 (git checkout -b feature/AmazingFeature)
3. 提交更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 打开Pull Request

📄 许可证

本项目在MIT许可证下授权 - 有关详细信息，请参阅LICENSE文件。

致谢

• 感谢Reddit讨论中的原始规则 Reddit讨论
• 感谢模型上下文协议社区