Codebywaqas MRConfluenceLinker MCP Server

🚀 GitLab PR 分析 MCP 服務器

本項目提供了一個 MCP（模型控制協議）服務器，它將 GitLab 合併請求分析與 Confluence 文檔進行集成。通過該服務器，您可以獲取合併請求的詳細信息、分析代碼更改，並將分析結果存儲在 Confluence 頁面中。

🚀 快速開始

此項目提供的 MCP 服務器能有效集成 GitLab 合併請求分析與 Confluence 文檔。您可以按以下步驟快速開啟使用：

1. 完成安裝與配置。
2. 運行服務器並訪問文檔。
3. 利用 API 端點獲取所需信息。

✨ 主要特性

• 獲取詳細信息：可獲取 GitLab 的合併請求詳細信息。
• 代碼更改分析：對合並請求中的代碼更改進行分析。
• 詳細報告生成：生成的詳細報告涵蓋基本合併請求信息、代碼更改統計信息、文件類型分析以及詳細文件更改等內容。
• 結果存儲：將分析結果存儲在 Confluence 中。
• 全面日誌記錄：提供全面的日誌記錄，方便進行調試。

📦 安裝指南

先決條件

• Python 3.8 或更高版本。
• 帶有 API 訪問權限的 GitLab 賬戶。
• Confluence 賬戶（可選，用於存儲分析結果）。
• 具備訪問所需 GitLab 項目的權限。

安裝步驟

1. 克隆倉庫：

git https://github.com/CodeByWaqas/MRConfluenceLinker-mcp-server.git
cd MRConfluenceLinker-mcp-server

2. 創建並激活虛擬環境：

python -m venv .venv
source .venv/bin/activate  # 在 Windows 上，使用：.venv\Scripts\activate

3. 安裝依賴項：

pip install -r requirements.txt

或

uv add "mcp[cli]" python-gitlab python-dotenv atlassian-python-api

📚 詳細文檔

配置

創建 config.py 文件並添加以下內容：

# config.py
from mcp_server import resources

resources.initialize()

使用方法

1. 運行服務器：

uvicorn --reload mcp_server.server:app

2. 訪問文檔：在默認瀏覽器中打開 http://localhost:8000/docs

3. 使用 API 端點：

   • /api/v1/prs：獲取所有合併請求。
   • /api/v1/pr/{pr_id}：獲取特定合併請求的詳細信息。

項目結構

MRConfluenceLinker-mcp-server/
├── src/                           # 源代碼目錄
│   └── 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/mcp_server/ 目錄中

  • server.py：主要 MCP 服務器實現。
  • resources/client.py：客戶端實現，包含 GitLab PR 集成。

• 配置文件：

  • requirements.txt：Python 包依賴項。
  • pyproject.toml：項目元數據和構建配置。
  • uv.lock：鎖定的依賴版本。
  • .env.example：環境變量模板。

📄 許可證

本項目的許可證信息可查看項目根目錄下的 LICENSE 文件。