Gitlab MR Confluence Linker

🚀 GitLab PR 分析 MCP 服務器

本項目提供了一個 MCP（模型控制協議）服務器，它將 GitLab 合併請求分析與 Confluence 文檔進行了集成。藉助該服務器，您能夠從 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
   

✨ 主要特性

• 從 GitLab 獲取合併請求詳細信息
• 分析合併請求中的代碼更改
• 生成包含以下內容的詳細報告：
  • 基本合併請求信息
  • 代碼更改統計信息
  • 文件類型分析
  • 詳細的文件更改
• 將分析結果存儲在 Confluence 中
• 全面的日誌記錄以備調試

💻 使用示例

配置與集成

• 將 MCP 服務器與 Claude Desktop 集成，請參考 CONTRIBUTING.md 文件中的指導。
• 更新 pyproject.toml 和 requirements.txt 文件以管理項目依賴關係。

工具使用

以下是 MCP 服務器的主要功能：

1. 拉取合併請求詳細信息：

   • 使用 GitLab API 獲取指定倉庫的合併請求列表和詳細信息。

2. 分析代碼更改：

   • 掃描合併請求中的代碼變更，生成差異報告並識別潛在問題。

3. 存儲到 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 文件。