Agent Rules MCP

🚀 Agent Rules MCP Server

这个MCP服务器让你的工作区无需本地规则文件。你不必再将编码标准复制到每个项目中，现在可以提示AI代理从公共仓库或你自己的任何规则文件夹中获取特定的编码规则或所有规则。

项目徽章

🚀 快速开始

此MCP服务器可让你无需在工作区使用本地规则文件，而是能提示AI代理从公共仓库或你自己的仓库中获取规则。

✨ 主要特性

• GitHub集成：可从任何GitHub仓库获取规则。
• 简单设置：通过环境变量进行配置，无需本地文件。
• 可配置：支持自定义仓库、分支和路径。
• 社区规则：可与现有的规则集合（如 awesome-cursorrules 和 awesome-copilot 等）配合使用。
• 复合扩展：支持 .chatmode.md、.prompt.md、.instructions.md 文件。
• 灵活格式：支持任何带或不带元数据的Markdown文件（.md/.mdc）。

📦 安装指南

将以下配置添加到你的MCP客户端（如VS Code、Kiro、Cursor、Windsurf等）：

{
  "mcpServers": {
    "agent-rules": {
      "command": "npx",
      "args": ["-y","agent-rules-mcp@latest"],
      "env": {
        "GITHUB_OWNER": "4regab",
        "GITHUB_REPO": "agent-rules-mcp",
        "GITHUB_PATH": "rules",
        "GITHUB_BRANCH": "master"
      },
      "disabled": false
    }
  }
}

💻 使用示例

基础用法

社区规则集合的使用示例

GitHub Awesome Copilot集合

可即时访问社区维护的编码规则：

{
  "mcpServers": {
    "agent-rules": {
      "command": "npx",
      "args": ["-y","agent-rules-mcp@latest"],
      "env": {
        "GITHUB_OWNER": "github",
        "GITHUB_REPO": "awesome-copilot",         
        "GITHUB_PATH": "instructions",
        "GITHUB_BRANCH": "main"
      },
      "disabled": false
    }
  }
}

Awesome Cursor Rules集合

用于特定于Cursor的规则的替代集合：

{
  "mcpServers": {
    "agent-rules": {
      "command": "npx",
      "args": ["-y","agent-rules-mcp@latest"],
      "env": {
         "GITHUB_OWNER": "PatrickJS",
         "GITHUB_REPO": "awesome-cursorrules",
         "GITHUB_PATH": "rules-new",
         "GITHUB_BRANCH": "main"
         }
       }
     }
   }

使用你自己的规则文件夹仓库（推荐）

若要使用你自己的GitHub仓库而非默认仓库，可使用以下配置：

{
  "mcpServers": {
    "agentrules": {
      "command": "npx",
      "args": ["-y","agent-rules-mcp@latest"],
      "env": {
        "GITHUB_OWNER": "your-username",
        "GITHUB_REPO": "your-rules-repo",
        "GITHUB_PATH": "your-rules-folder",
        "GITHUB_BRANCH": "main"
      },
      "disabled": false
    }
  }
}

示例仓库结构：

my-coding-rules/
├── rules/                       # 传统的单目录
│   ├── python-style.md          # 带元数据的标准Markdown文件
│   ├── react-patterns.mdc       # 支持MDC格式
│   └── security-checklist.md    # 带有YAML前置元数据
├── README.md
└── .gitignore

高级用法

按需访问规则对AI代理的帮助

之前（传统方法）：

my-project/
├──rules                  ← 需要本地规则文件
│   ├── react-rules.md
│   ├── security-rules.md
│   └── typescript-rules.md
├── src/
└── package.json

之后（agent-rules MCP方法）：

my-project/
├── src/
└── package.json          ← 干净的工作区，无需本地规则

# 在编码代理中：
"Apply React best practices to this component"
→ 代理自动从你的规则文件夹中获取React规则

灵活支持和文件格式兼容性

该服务器支持各种文件格式和命名约定： 支持的扩展名：

• .md - 标准Markdown文件
• .mdc - MDC（Markdown组件）文件
• .chatmode.md - AI助手模式定义
• .prompt.md - 提示模板
• .instructions.md - 编码指令文件 自动元数据提取： 如果未提供明确的元数据，服务器将：
• 提取第一个标题作为标题
• 使用第一段作为描述
• 根据文件名生成备用描述
• 在可用时解析YAML前置元数据 域名处理：
• accessibility.chatmode.md → 域名: accessibility
• react-best-practices.instructions.md → 域名: react-best-practices
• 4.1-Beast.chatmode.md → 域名: 4.1-Beast（支持点和特殊字符） 这意味着你可以直接使用现有的任何Markdown文档作为规则，无需修改。

📚 详细文档

可用工具

• get_rules：从GitHub仓库的规则文件夹中检索一个或多个域的规则内容。
• list_rules：列出所有可用的规则域及其描述。

🔧 技术细节

贡献指南

我们欢迎对默认规则仓库进行贡献！

• 清晰的域名：使用描述性的、短横线分隔的文件名。
• 完整的元数据：包括描述和最后更新日期。
• 高质量内容：提供可操作的、组织良好的规则，并带有示例。
• 本地测试：验证你的规则可与MCP服务器配合使用。
• 遵循格式：使用标准的Markdown结构。 推荐结构（以实现最佳元数据提取）：

# 编码规则标题

- 最后更新日期: YYYY-MM-DD
- 描述: 规则的简要描述（用于 `list_rules()` 响应）
- 版本: X.X（可选，用于跟踪重大更改）

## 内容 

📄 许可证

本项目采用MIT许可证，详情请参阅 LICENSE 文件。

支持

• 问题反馈：在GitHub Issues上报告错误和提出功能请求。
• 文档查阅：查看本README和内联代码文档。