MCP Merge Request Summarizer

🚀 MCPマージリクエスト要約ツール

MCP（Model Context Protocol）ツールで、gitログから包括的なマージリクエストの要約を自動生成します。このツールはコミット履歴を分析し、変更点を分類し、マージリクエストの説明に適した構造化された要約を作成します。

🚀 クイックスタート

このツールを使用することで、gitログから自動的に包括的なマージリクエストの要約を生成できます。以下に手順や使用方法を解説します。

✨ 主な機能

• 自動コミット分析：ブランチ間の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. エディタを設定します：

   • 30秒で設定する手順はQUICK_START.mdを参照してください。
   • 詳細な設定オプションは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ファイルを参照してください。

🙏 謝辞

• Model Context Protocol（MCP）エコシステム向けに開発されました。
• より良いマージリクエストのドキュメントの必要性に触発されています。
• すべての貢献者とユーザーに感謝します。

📞 サポート

• 問題報告：GitHub Issues
• ディスカッション：GitHub Discussions
• ドキュメント：Wiki

❤️ より良いマージリクエストの要約を望む開発者のために作られました