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和內聯代碼文檔。