Mrconfluencelinker MCP Server

🚀 GitLab PR 分析 MCP 服務器項目文檔

GitLab PR 分析 MCP 服務器是一款用於自動化處理 GitLab 上合併請求（Pull Requests）的工具。它能夠與 Confluence 集成，助力團隊記錄和共享開發活動，提升團隊協作效率。

🚀 快速開始

先決條件

1. Python 3.8 或更高版本
2. GitLab 賬號及 API 訪問權限
3. 可選：Confluence 賬號及 API 訪問權限

安裝步驟

方式一：使用 pip 安裝依賴

pip install -r requirements.txt

方式二：使用 uv 管理依賴

uv add

配置說明

1. 複製 .env.example 到項目根目錄並重命名為 .env
2. 編輯 .env 文件，填寫以下環境變量：
   • GITLAB_URL: GitLab 實例的 URL
   • GITLAB_TOKEN: GitLab API 訪問 Token
   • CONFLUENCE_URL: Confluence 實例的 URL（可選）
   • CONFLUENCE_TOKEN: Confluence API 訪問 Token（可選）

啟動服務器

方式一：直接運行 server.py

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

方式二：通過 Claude Desktop 配置啟動

在 Claude Desktop 中添加以下配置到 uv.json：

{
  "name": "gitlab-pr-analysis",
  "path": "/path/to/your/project/src/MRConfluenceLinker-mcp-server/server.py"
}

✨ 主要特性

• 獲取合併請求詳情：從 GitLab 獲取詳細的合併請求信息。
• 分析代碼變更：對合並請求中的代碼變更進行深入分析。
• 生成報告：包括基本合併請求信息、代碼統計、文件類型分析等詳細報告。
• 集成 Confluence：將分析結果存儲到 Confluence 中，方便團隊協作和共享。

💻 使用示例

基礎用法

1. 獲取合併請求詳情（fetch_mr_details）

# 從 GitLab 獲取指定項目的合併請求詳細信息
# 參數:
# - project_id: 要獲取的項目 ID
# - mr_id: 要獲取的合併請求 ID
fetch_mr_details(project_id, mr_id)

2. 分析代碼變更（analyze_code_changes）

# 分析合併請求中的代碼變更，生成詳細的變更報告
# 參數:
# - project_id: 要分析的項目 ID
# - mr_id: 要分析的合併請求 ID
analyze_code_changes(project_id, mr_id)

3. 存儲到 Confluence（store_in_confluence）

# 將合併請求的詳細信息和分析結果存儲到 Confluence 中
# 參數:
# - project_id: 要存儲的項目 ID
# - mr_id: 要存儲的合併請求 ID
store_in_confluence(project_id, mr_id)

📚 詳細文檔

工具說明

1. 獲取合併請求詳情（fetch_mr_details）

• 功能：從 GitLab 獲取指定項目的合併請求詳細信息。
• 參數：
  • project_id: 要獲取的項目 ID
  • mr_id: 要獲取的合併請求 ID

2. 分析代碼變更（analyze_code_changes）

• 功能：分析合併請求中的代碼變更，生成詳細的變更報告。
• 參數：
  • project_id: 要分析的項目 ID
  • mr_id: 要分析的合併請求 ID

3. 存儲到 Confluence（store_in_confluence）

• 功能：將合併請求的詳細信息和分析結果存儲到 Confluence 中。
• 參數：
  • project_id: 要存儲的項目 ID
  • mr_id: 要存儲的合併請求 ID

日誌記錄

服務器運行時會在 mcp_server.log 文件中生成日誌，便於調試和排查問題。

錯誤處理

項目內置了多種錯誤處理機制，包括：

• 認證失敗：驗證環境變量是否正確。
• 網絡問題：檢查 API 訪問權限和 URL 是否有效。
• 其他異常：查看 mcp_server.log 日誌文件以獲取更多信息。

貢獻指南

1. Fork 項目倉庫
2. 創建功能分支
3. 提交代碼更改
4. 提出 Pull Request

項目結構

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                    # 項目說明
└── requirements.txt             # 依賴項管理文件

聯繫方式

如有任何問題或建議，請聯繫項目維護人員。

📄 許可證

本項目的許可證信息請查看 LICENSE 文件。