Style Guidelines

🚀 MCPRules - 編程規範管理服務器

一個強大的模型上下文協議（MCP）服務器，用於管理和提供編程指南和規則。該服務器可與開發工具集成，助力項目實現一致的編碼標準。

🚀 快速開始

MCPRules 是一個強大的模型上下文協議（MCP）服務器，可用於管理和提供編程指南與規則。以下是快速開始使用該服務器的步驟：

1. 克隆倉庫

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

2. 安裝依賴項

   npm install
   

3. 構建服務器

   npm run build
   

4. 配置環境變量

   export RULES_FILE_PATH=/path/to/your/rules.md
   # 可選，用於私有GitHub倉庫
   export GITHUB_TOKEN=你的_github_token
   

✨ 主要特性

規則管理

• 通過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
key: value

開發

• 監控模式

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文件。

致謝

• 感謝Reddit討論中的原始規則 Reddit討論。
• 感謝模型上下文協議社區。