MCP Merge Request Summarizer

🚀 MCP合併請求摘要生成器

MCP（模型上下文協議）工具，可根據git日誌自動生成全面的合併請求摘要。該工具分析提交歷史，對更改進行分類，並生成適合合併請求描述的結構化摘要。

🚀 快速開始

MCP合併請求摘要生成器是一款強大的工具，能幫助開發者更高效地處理合併請求。它可以自動分析提交歷史，生成詳細的摘要。

✨ 主要特性

• 自動提交分析：分析分支之間的git日誌，以瞭解更改情況。
• 智能分類：按類型（功能、錯誤修復、重構等）對提交進行分類。
• 全面摘要：生成詳細的合併請求描述，包含：
  • 概述和統計信息
  • 關鍵更改和重要提交
  • 分類更改（功能、錯誤修復、重構）
  • 重大更改檢測
  • 文件分類和影響分析
  • 預估審核時間
• 多種輸出格式：支持Markdown和JSON輸出。
• 靈活集成：可獨立運行，也可作為MCP服務器使用。
• 跨平臺：與Windows、macOS和Linux兼容。

📦 安裝指南

🚀 快速開始（推薦）

1. 克隆倉庫：

   git clone https://github.com/yourusername/mcp-merge-request-summarizer.git
   cd mcp-merge-request-summarizer
   

2. 運行安裝腳本：

   • Windows：雙擊install.bat或在PowerShell中運行install.bat。
   • Mac/Linux：運行chmod +x install.sh && ./install.sh。

3. 配置編輯器：

   • 查看QUICK_START.md獲取30秒設置說明。
   • 或查看configs/README.md獲取詳細配置選項。

手動安裝

git clone https://github.com/yourusername/mcp-merge-request-summarizer.git
cd mcp-merge-request-summarizer
pip install -e .

從PyPI安裝

pip install mcp-merge-request-summarizer

⚠️ 重要提示

該軟件包尚未發佈到PyPI。目前，請使用安裝腳本或手動安裝。

💻 使用示例

作為獨立工具使用

# 基本用法（將當前分支與develop分支進行比較）
python -m mcp_mr_summarizer.cli

# 指定不同的分支
python -m mcp_mr_summarizer.cli --base main --current feature/new-feature

# 輸出到文件
python -m mcp_mr_summarizer.cli --output mr_summary.md

# JSON輸出
python -m mcp_mr_summarizer.cli --format json --output summary.json

# 幫助信息
python -m mcp_mr_summarizer.cli --help

作為MCP服務器使用

1. 配置MCP客戶端（例如，Claude Desktop、Cursor、VSCode）：

   {
     "mcp.servers": {
       "merge-request-summarizer": {
         "command": "python",
         "args": ["-m", "mcp_mr_summarizer.server"]
       }
     }
   }
   

2. 設置工作目錄上下文（推薦）：

   # 設置工作目錄，以便repo_path="."能正常工作
   await set_working_directory("/path/to/your/git/repo")
   

3. 通過MCP客戶端界面使用工具和資源：

工具（操作）

• set_working_directory：設置代理的工作目錄上下文。
• get_working_directory：獲取當前工作目錄上下文。
• generate_merge_request_summary：創建完整的合併請求摘要。
• analyze_git_commits：提供詳細的提交分析。

資源（數據）

• git://repo/status：當前倉庫狀態和信息。
• git://commits/{base_branch}..{current_branch}：分支之間的提交歷史。
• git://branches：所有倉庫分支的列表。
• git://files/changed/{base_branch}..{current_branch}：分支之間更改的文件。

📊 示例輸出

# feat: 4個新功能和改進

## 概述
此合併請求包含9次提交，更改了35個文件（插入1543行，刪除1485行）。

## 關鍵更改
- 重構MLB、NBA、NHL和NFL中的映射器，以使用對象初始化器語法（bdf5d9c） - 更改3028行。
- 重構賽季統計服務，以使用基類並改進依賴注入（30de323） - 更改1976行。

### 🚀 新功能（4個）
- 添加足球指標提取方法並註冊足球賽季統計服務（176930f）。
- 更新服務以使用構造函數注入依賴項（29f1c46）。
- 更新CbStatsDaemon和CbStatsFeedPublicApi以使用異步主機運行方法（22c1202）。
- 重構PoolSeasonStatsController和相關服務（3a28ab4）。

### 🔧 重構（3個）
- 重構MLB、NBA、NHL和NFL中的映射器，以使用對象初始化器語法（bdf5d9c）。
- 重構賽季統計服務，以使用基類並改進依賴注入（30de323）。
- 重構賽季統計服務中的日誌記錄，以使用一致的大小寫（fd7b8b9）。

### 📊 摘要
- **總提交數**：9
- **更改文件數**：35
- **插入行數**：1543
- **刪除行數**：1485
- **預估審核時間**：1小時15分鐘

🛠️ 配置

快速配置（推薦）

對於VSCode/Cursor

1. 打開設置（Ctrl/Cmd + ,）。
2. 對於VSCode：搜索“mcp”並點擊“在settings.json中編輯”。
3. 對於Cursor：轉到工具與集成 → 新MCP服務器。
4. 添加以下配置：

VSCode（settings.json）：

{
  "mcp.servers": {
    "merge-request-summarizer": {
      "command": "python",
      "args": ["-m", "mcp_mr_summarizer.server"]
    }
  }
}

Cursor（GUI或settings.json）：

• 名稱：merge-request-summarizer
• 命令：python
• 參數：["-m", "mcp_mr_summarizer.server"]

Cursor（替代JSON格式）：

{
  "mcpServers": {
    "merge-request-summarizer": {
      "command": "python",
      "args": ["-m", "mcp_mr_summarizer.server"]
    }
  }
}

對於Claude Desktop

1. 轉到設置 → MCP服務器。
2. 添加具有以下配置的新服務器：

{
  "mcpServers": {
    "merge-request-summarizer": {
      "command": "python",
      "args": ["-m", "mcp_mr_summarizer.server"]
    }
  }
}

即用型配置文件

從configs/文件夾中複製適當的配置：

• configs/vscode_settings.json - 用於VSCode。
• configs/cursor_settings.json - 用於Cursor。
• configs/claude_desktop_config.json - 用於Claude Desktop。

查看configs/README.md獲取詳細設置說明。

🎯 自定義

添加自定義提交類別

通過修改categorize_commit方法擴展類別：

def categorize_commit(self, commit: CommitInfo) -> List[str]:
    categories = []
    message_lower = commit.message.lower()
    
    # 添加自定義模式
    if any(word in message_lower for word in ['security', 'vulnerability']):
        categories.append('security')
    
    # ... 現有模式 ...
    
    return categories

自定義文件類別

添加自定義文件類型類別：

def _categorize_files(self, files: set) -> Dict[str, List[str]]:
    categories = {
        'Services': [],
        'Models': [],
        'Controllers': [],
        'Tests': [],
        'Configuration': [],
        'Documentation': [],
        'CustomCategory': [],  # 添加自定義類別
        'Other': []
    }
    
    for file in files:
        if 'CustomPattern' in file:  # 添加自定義模式
            categories['CustomCategory'].append(file)
        # ... 現有模式 ...
    
    return categories

🧪 測試

# 運行測試
python -m pytest tests/

# 運行並生成覆蓋率報告
python -m pytest tests/ --cov=mcp_mr_summarizer --cov-report=html

🤝 貢獻

1. 分叉倉庫。
2. 創建功能分支（git checkout -b feature/amazing-feature）。
3. 進行更改。
4. 為更改添加測試。
5. 運行測試套件。
6. 提交更改（git commit -m 'Add some amazing feature'）。
7. 推送到分支（git push origin feature/amazing-feature）。
8. 打開拉取請求。

📝 許可證

本項目採用MIT許可證 - 有關詳細信息，請參閱LICENSE文件。

🙏 致謝

• 為模型上下文協議（MCP）生態系統構建。
• 受對更好的合併請求文檔需求的啟發。
• 感謝所有貢獻者和用戶。

📞 支持

• 問題反饋：GitHub問題
• 討論交流：GitHub討論
• 文檔資料：Wiki

為想要更好合並請求摘要的開發者用心打造 ❤️