编程指南管理服务

一个基于模型上下文协议(MCP)的服务,用于管理和提供编程指南和规则,确保项目间一致的编码标准。

  • by bartwisch
  • JavaScript
  • 本地部署
  • 22 星标
  • 更新于
在 GitHub 查看 bartwisch/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
    # Optional for private GitHub repositories
    export GITHUB_TOKEN=your_github_token
    

配置

用于VSCode临床扩展

地点: ~/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": []
    }
  }
}

适用于克劳德桌面

地点: ~/Library/Application Support/Claude/claude_desktop_config.json

用法

可用工具

  1. 获取规则

    // Retrieve all rules or filter by category
    {
      "category": "optional-category-name"
    }
    
  2. 获取类别

    // List all available rule categories
    {}
    

规则格式

规则存储在具有以下结构的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. 打开拉取请求

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

致谢

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