Back to MCP directory
publicPublicdnsLocal runtime

MCPRules

一个基于Model Context Protocol(MCP)的编程规则管理服务器,用于统一管理和提供编程规范指南,支持多种存储方式和分类组织。

article

README

🚀 MCP 规则管理服务器 - 编程规范管理服务器

一个强大的模型上下文协议(MCP)服务器,用于管理和提供编程指南和规则。该服务器可与开发工具集成,助力项目实现一致的编码标准。

TypeScript MCP License: MIT

🚀 快速开始

本 MCP 规则管理服务器是一个强大的工具,用于管理和提供编程指南与规则,能与开发工具集成,确保项目中的编码标准一致。

✨ 主要特性

规则管理

  • 通过 MCP 工具访问规则。
  • 可按类别过滤规则。
  • 支持本地和 GitHub 主机托管的规则。
  • 具备类别和键值对的结构化规则格式。

灵活存储

  • 支持本地文件系统。
  • 集成 GitHub 仓库。
  • 基于 Markdown 定义规则。

分类组织

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

📦 安装指南

克隆仓库

git clone https://github.com/yourusername/MCPRules.git
cd MCPRules/rules-server

安装依赖项

npm install

构建服务器

npm run build

配置环境变量

export RULES_FILE_PATH=/path/to/your/rules.md
# 可选的 GitHub 私有仓库
export GITHUB_TOKEN=你的_github_token

📚 详细文档

配置

对于 VSCode Cline 扩展

位置: ~/Library/Application Support/Windsurf/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json

{
  "mcpServers": {
    "rules": {
      "command": "node",
      "args": ["/path/to/rules-server/build/index.js"],
      "disabled": false,
      "alwaysAllow": []
    }
  }
}

对于 Claude Desktop

位置: ~/Library/Application Support/Claude/claude_desktop_config.json

使用

可用工具

获取规则
// 获取所有规则或按类别筛选
{
  "category": "optional-category-name"
}
获取分类
// 列出所有可用的规则分类
{}

规则格式

规则存储在 Markdown 文件中,具有以下结构:

#Category
键: 值

开发

监控模式

npm run watch

调试

npm run inspector

贡献

  1. 叉克隆仓库。
  2. 创建功能分支 (git checkout -b feature/AmazingFeature)。
  3. 提交更改 (git commit -m 'Add some AmazingFeature')。
  4. 推送到分支 (git push origin feature/AmazingFeature)。
  5. 打开 Pull Request。

📄 许可证

该项目在 MIT License 下许可 - 有关详细信息,请参阅 LICENSE 文件。

致谢

  • 感谢 Reddit 讨论中的原始规则 Reddit 讨论
  • 感谢 Model Context Protocol 社区。
help

Runtime guide

cloud

Hosted runtime

Hosted servers run from a provider-managed environment. You usually connect the MCP client to the hosted endpoint or follow the provider's authorization flow, without keeping a local process alive

  1. Open provider connection page
  2. Authorize or copy endpoint
  3. Connect from your MCP client
terminal

Local runtime / other methods

Local servers run on your own machine or infrastructure. You normally copy the server_config into your MCP client, install the required package, and provide env variables from env_schema when needed

  1. Copy server_config
  2. Install required package
  3. Fill env variables and restart client