此 MCP 服务器消除了在工作空间中使用本地规则文件的需求。无需将编码标准复制到每个项目中,现在可以提示 AI 代理从公共仓库或您自己的仓库中的任何规则文件夹获取特定的编码规则。
将以下配置添加到您的 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
}
}
}
立即访问由社区维护的编码规则:
{
"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
}
}
}
用于光标特定规则的替代集合:
{
"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 仓库而不是默认仓库:
{
"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
之前(传统方法):
my-project/
├──rules ← 需要本地规则文件
│ ├── react-rules.md
│ ├── security-rules.md
│ └── typescript-rules.md
├── src/
└── package.json
之后(agent-rules MCP 方法):
my-project/
├── src/
└── package.json ← 清洁的工作空间,不需要本地规则
# 在编码代理中:
"应用这些组件的最佳 React 实践"
→ 代理自动从您的规则文件夹中获取 React 规则
该服务器支持各种文件格式和命名约定:
支持的扩展名:
.md - 标准 Markdown 文件.mdc - MDC(Markdown 组件)文件.chatmode.md - AI 助手模式定义.prompt.md - 提示模板.instructions.md - 编码指令文件自动元数据提取: 如果没有提供明确的元数据,服务器将:
领域名称处理:
accessibility.chatmode.md → 领域:accessibilityreact-best-practices.instructions.md → 领域:react-best-practices4.1-Beast.chatmode.md → 领域:4.1-Beast(支持点和特殊字符)这意味着您可以使用任何现有的 Markdown 文档作为规则,而无需修改。
我们欢迎对默认规则仓库的贡献!
推荐结构(以实现最佳元数据提取):
# 编码规则的标题
- 最后更新:YYYY-MM-DD
- 描述:规则的简要描述(用于 list_rules() 响应)
- 版本:X.X(可选,用于跟踪重大更改)
## 内容
由 Kiro 为 Code-with-kiro 黑客马拉松 制作。
MIT 许可证 - 查看 LICENSE 文件以获取详细信息。