Gitlab MR Confluence Linker

🚀 GitLab PR 分析 MCP サーバー

このプロジェクトは、GitLab のマージリクエスト分析と Confluence ドキュメントを統合した MCP（モデル制御プロトコル）サーバーを提供します。GitLab からマージリクエストの詳細を取得し、コードの変更を分析し、結果を Confluence ページに保存することができます。

🚀 クイックスタート

このセクションでは、GitLab PR 分析 MCP サーバーを迅速にセットアップして使用する手順を説明します。

✨ 主な機能

• GitLab からマージリクエストの詳細を取得します。
• マージリクエスト内のコードの変更を分析します。
• 以下の内容を含む詳細なレポートを生成します：
  • 基本的なマージリクエスト情報
  • コード変更の統計情報
  • ファイルタイプの分析
  • 詳細なファイル変更内容
• 分析結果を Confluence に保存します。
• デバッグ用の包括的なログ記録を行います。

📦 インストール

前提条件

• Python 3.8 以上
• GitLab アカウントと API アクセス権限
• Confluence アカウントと REST API アクセス権限

インストール手順

1. このプロジェクトをクローンします：

git clone https://git.example.com/gitlab-pr-analysis.git
cd gitlab-pr-analysis

2. 仮想環境をアクティブ化します（推奨）：

python -m venv env
source env/bin/activate  # macOS/Linux の場合
.\env\Scripts\activate  # Windows の場合

3. 依存関係をインストールします：

pip install -r requirements.txt

4. 環境変数を設定します：

• .env ファイルを作成し、以下の内容を記入します：

GITHUB_TOKEN=your_github_token
CONFLUENCE_BASE_URL=https://your.confluence.url
CONFLUENCE_API_KEY=your_confluence_api_key

5. MCP サーバーを起動します：

python src/MRConfluenceLinker-mcp-server/server.py

💻 使用例

設定と統合

• MCP サーバーを Claude Desktop と統合するには、CONTRIBUTING.md ファイルのガイドを参照してください。
• プロジェクトの依存関係を管理するには、pyproject.toml と requirements.txt ファイルを更新してください。

ツールの使用

以下は MCP サーバーの主な機能です：

基本的な使用法

# マージリクエストの詳細を取得する例
# ここでは具体的なコードがないので概念的な説明にとどめます
# GitLab API を使用して指定したリポジトリのマージリクエストのリストと詳細情報を取得します

高度な使用法

# コード変更の分析と Confluence への保存
# ここでは具体的なコードがないので概念的な説明にとどめます
# マージリクエスト内のコードの変更をスキャンし、差分レポートを生成して潜在的な問題を識別します
# その後、分析結果を自動的に Confluence ページにアップロードします

📚 ドキュメント

プロジェクト構造

MRConfluenceLinker-mcp-server/
├── src/                           # ソースコードディレクトリ
│   └── MRConfluenceLinker-mcp-server/  # メインサーバーパッケージ
│       ├── resources/            # リソースモジュール
│       │   ├── __init__.py
│       │   ├── client.py        # クライアント実装 / GitLab PR 統合
│       ├── server.py            # メインサーバー実装
│       └── mcp_server.log       # サーバーログ
├── __pycache__/                 # Python キャッシュファイル
├── .git/                        # Git リポジトリ
├── .gitignore                   # Git 無視ルール
├── CONTRIBUTING.md              # 貢献ガイド
├── LICENSE                      # プロジェクトライセンス
├── README.md                    # プロジェクトドキュメント
├── pyproject.toml              # Python プロジェクト設定
├── requirements.txt            # プロジェクト依存関係
└── uv.lock                     # 依存バージョンロックファイル

主要コンポーネント

• ソースコード：src/MRConfluenceLinker-mcp-server/ ディレクトリにあります。

  • server.py：メインの MCP サーバーの実装です。
  • resources/client.py：クライアントの実装で、GitLab PR の統合を含みます。

• 設定ファイル：

  • requirements.txt：Python パッケージの依存関係です。
  • pyproject.toml：プロジェクトのメタデータとビルド設定です。
  • uv.lock：ロックされた依存バージョンです。
  • .env.example：環境変数のテンプレートです。

📄 ライセンス

このプロジェクトのライセンスについては、LICENSE ファイルを参照してください。