Custom GitLab MCP Server

🚀 GitLab 代碼合併請求審查機器人

這是一款集成了 Anthropic 的 Claude 模型的 AI 動態 GitLab 合併請求代碼審查工具，能夠自動化開展代碼審查工作，並對檢查清單的合規性進行評估，為代碼質量保駕護航。

🚀 快速開始

GitLab 代碼合併請求審查機器人能在合併請求打開或更新時，自動進行代碼審查，分析代碼樣式、質量、安全等問題，依據團隊標準開展檢查清單評估，還能提供詳細反饋與最終建議。

✨ 主要特性

• 當打開或更新合併請求時，自動開展代碼審查工作。
• 深入分析代碼中的樣式、質量、安全問題以及最佳實踐。
• 依據團隊標準，對 MR 進行自定義檢查清單評估。
• 為每個文件提供詳細反饋。
• 給出整體評估，並提供最終建議（批准、小修後批准、需要修改）。
• 支持通過 GitLab webhook 自動觸發或手動觸發。
• 可選擇將結果發送到 Slack 進行通知。

📦 安裝指南

先決條件

• Node.js（v14 或更高版本）
• npm 或 yarn
• 帶有 API 訪問權限的 GitLab 賬戶
• Anthropic Claude API 密鑰

安裝步驟

1. 克隆倉庫：

   git clone <repository-url>
   cd gitlab-mr-reviewer
   

2. 安裝依賴項：

   npm install
   

3. 複製示例環境文件並更新為您的配置：

   cp .env.example .env
   

   編輯 .env 文件，用您的 GitLab 和 Claude 憑據替換相關值。

📚 詳細文檔

配置

在 .env 文件中更新以下變量：

# GitLab 配置
GITLAB_API_URL=https://gitlab.example.com/api/v4
GITLAB_PRIVATE_TOKEN=your_private_token_here
GITLAB_WEBHOOK_SECRET=your_webhook_secret_here

# Anthropic Claude 配置
CLAUDE_API_KEY=your_claude_api_key_here
CLAUDE_MODEL=claude-3-opus-20240229

# 應用配置
PORT=3000
NODE_ENV=development

# 日誌記錄配置
LOG_LEVEL=info

# Slack 通知（可選）
SLACK_WEBHOOK_URL=your_slack_webhook_url_here

合併請求檢查清單

該工具根據團隊標準對每個合併請求進行以下檢查：

1. 變更描述清晰且完整。
2. 鏈接了 Trello 卡片。
3. version.json 中版本號已增加。
4. Trello 卡片有詳細說明。
5. 如果需要，proto 文件是否更新。
6. 錯誤處理（try - catch）是否正確實現，並在適當位置添加 Slack 通知。
7. 函數長度不超過 50 行（或有解釋說明）。
8. 合併請求聚焦於單一目的（邏輯變更或重構）。
9. 是否添加了單元測試。
10. 文檔是否已更新。

這些檢查通過 src/services/claude.service.js 中的 MR_CHECKLIST 常量實現，可以根據需要進行自定義。

📄 許可證

本項目採用 MIT License 開源協議。

🤝 貢獻指南

歡迎貢獻！請隨意提交 Pull Request。