MCPRules - Programming Guidelines Management Server

基本能力

产品定位

MCPRules 是一个用于管理和服务编程指南及规则的 MCP 服务器，旨在帮助开发团队维护一致的编码标准。

核心功能

• 规则管理
• 通过 MCP 工具访问规则
• 按类别过滤规则
• 支持本地和 GitHub 托管的规则

• 结构化的规则格式，包含类别和键值对

• 灵活存储

• 本地文件系统支持
• GitHub 仓库集成

• 基于 Markdown 的规则定义

• 分类组织

• 核心编程原则
• 代码风格和格式化
• 语言特定指南
• 项目管理规则
• 操作系统特定规则

适用场景

• 开发团队维护和共享编程规范
• 项目需要一致的编码标准
• 需要从本地或 GitHub 仓库获取规则

工具列表

1. Get Rules

2. 检索所有规则或按类别过滤 typescript { "category": "optional-category-name" }

3. Get Categories

4. 列出所有可用的规则类别 typescript {}

常见问题解答

• 规则存储在 Markdown 文件中，格式如下： markdown #Category key: value

使用教程

使用依赖

1. 克隆仓库 bash git clone https://github.com/yourusername/MCPRules.git cd MCPRules/rules-server

2. 安装依赖 bash npm install

安装教程

1. 构建服务器 bash npm run build

2. 配置环境变量 bash export RULES_FILE_PATH=/path/to/your/rules.md # 可选，用于私有 GitHub 仓库 export GITHUB_TOKEN=your_github_token

调试方式

1. 监视模式 bash npm run watch

2. 调试 bash npm run inspector

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。