代理规则MCP服务器
此MCP服务器消除了对工作区中本地规则文件的需要。现在，您无需将编码标准复制到每个项目中，而是可以 提示AI代理获取特定的编码规则 或者从公共存储库或您自己的任何规则文件夹中删除所有规则。
特性
- GitHub集成：从任何GitHub存储库获取规则
- 简单设置：配置环境变量，不需要本地文件
- 可配置的：支持自定义存储库、分支和路径
- 社区规则：与现有收藏一起使用，如 awesome-游标 和 很棒的副驾驶等等。
- 复合扩展：支持.chatmode.md、.prompt.md、.instructions.md文件
- 灵活的格式：支持任何有或没有元数据的markdown文件（.md/.mdc）
MCP客户端配置（默认）
将此配置添加到您的MCP客户端（VS Code、Kiro、Cursor、Windsurf等）：```json
{
"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精彩副驾驶合集
立即访问社区维护的编码规则：```json
{
"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
}
}
}
真棒光标规则集合
游标特定规则的替代集合：```json
{
"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"
}
}
}
}
## 可用工具
- `get_rules`：从GitHub存储库规则文件夹中检索一个或多个域的规则内容。
- `list_rules`：列出所有可用的规则域及其说明。
### 使用自己的规则文件夹存储库（推荐）
要使用自己的GitHub存储库而不是默认存储库，请执行以下操作：```json
{
"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/ # Traditional single directory
│ ├── python-style.md # Standard markdown with metadata
│ ├── react-patterns.mdc # MDC format supported
│ └── security-checklist.md # With YAML frontmatter
├── README.md
└── .gitignore
## 这有什么帮助
### 人工智能代理的按需规则访问
**之前（传统方法）：**```
my-project/
├──rules ← Local rule files needed
│ ├── react-rules.md
│ ├── security-rules.md
│ └── typescript-rules.md
├── src/
└── package.json
之后（代理规则MCP方法）：```
my-project/
├── src/
└── package.json ← Clean workspace, no local rules needed
In Coding Agent:
"Apply React best practices to this component"
→ Agent automatically fetches React rules from your rules folder
### **灵活的支持和文件格式兼容性**
服务器使用各种文件格式和命名约定：
**支持的扩展：**
- `.md` -标准标记文件
- `.mdc` -MDC（Markdown组件）文件
- `.chatmode.md` -AI助手模式定义
- `.prompt.md` -提示模板
- `.instructions.md` -编码指令文件
**自动元数据提取：**
如果没有提供明确的元数据，服务器将：
- 提取第一个标题作为标题
- 使用第一段作为描述
- 根据文件名生成回退描述
- 解析YAML frontmatter（如果可用）
**域名处理：**
- `accessibility.chatmode.md` → 域名： `accessibility`
- `react-best-practices.instructions.md` → 域名： `react-best-practices`
- `4.1-Beast.chatmode.md` → 域名： `4.1-Beast` （支持点和特殊字符）
这意味着您可以使用任何现有的markdown文档作为规则，而无需进行修改。
## 贡献
我们欢迎对默认规则库的贡献！
- **清除域名**：使用描述性的烤肉串大小写文件名
- **完整元数据**：包括描述和上次更新日期
- **质量内容**：提供可操作、组织良好的规则和示例
- **本地测试**：验证您的规则是否适用于MCP服务器
- **遵循格式**：使用标准标记结构
**推荐结构（用于最佳元数据提取）：**```markdown
# Title of the coding rules
- Last Updated: YYYY-MM-DD
- Description: Brief description of the rules (used in list_rules() responses)
- Version: X.X (optional, for tracking major changes)
## Content
由以下材料制成 基洛 为了 与kiro黑客马拉松的代码.
许可证
MIT许可证-有关详细信息，请参阅许可证文件。
支持
- 问题：在GitHub Issues上报告错误和功能请求
- 文档：查看此README和内联代码文档
