README
🚀 GitLab MCP 代码审查
本项目是一个 MCP(模型上下文协议)服务器,旨在将 AI 助手(如Claude)与 GitLab 的合并请求集成,使 AI 助手能借助 GitLab API 直接审查代码更改。项目从 cayirtepeomer/gerrit-code-review-mcp 叉分而来,并针对 GitLab 集成做了适应性修改。
🚀 快速开始
此项目依赖 Python 3.10+、GitLab 个人访问令牌(需具备 API 权限,即 read_api 和 api 范围)以及 Cursor IDE 以实现 MCP 完全集成。以下是具体的安装步骤:
- 克隆仓库:
git clone https://github.com/yourusername/gitlab-mcp.git
cd gitlab-mcp
- 安装依赖项: 使用 pip 安装所需的 Python 包:
pip install -r requirements.txt
- 配置环境变量
创建一个
.env文件,并添加以下内容,替换为实际的 GitLab 令牌:
GITLAB_TOKEN=your_gitlab_token_here
- 运行应用程序: 启动 MCP 服务器:
python run.py
✨ 主要特性
- 完整的合并请求分析:获取有关合并请求的完整详细信息,包括差异、提交和评论
- 特定文件的差异:分析合并请求中特定文件的更改
- 版本比较:比较不同分支、标签或提交
- 审查管理:添加评论、批准或取消批准合并请求
- 项目概览:获取项目中所有合并请求的列表
📦 安装指南
先决条件
- Python 3.10+
- GitLab 个人访问令牌(具有 API 权限,即 read_api 和 api 范围)
- Cursor IDE 实现 MCP 完全集成
安装步骤
- 克隆仓库:
git clone https://github.com/yourusername/gitlab-mcp.git
cd gitlab-mcp
- 安装依赖项: 使用 pip 安装所需的 Python 包:
pip install -r requirements.txt
- 配置环境变量
创建一个
.env文件,并添加以下内容,替换为实际的 GitLab 令牌:
GITLAB_TOKEN=your_gitlab_token_here
- 运行应用程序: 启动 MCP 服务器:
python run.py
💻 使用示例
基础用法
配置文件示例
# .env 文件示例
GITLAB_TOKEN=your_actual_token
LOG_LEVEL=INFO
API_VERSION=v4
命令行选项
| 选项 | 描述 |
|------|------|
| --help | 显示帮助信息并退出 |
| -t, --token | 使用 GitLab 令牌进行身份验证 |
| -v, --version | 显示程序的版本号并退出 |
高级用法
查看项目列表
python run.py -t your_token
审查合并请求
python review.py --project-id 123 --merge-request-id 456
📚 详细文档
贡献指南
欢迎贡献!请参考 CONTRIBUTING.md 文件了解详细开发流程。
📄 许可证
此项目使用 MIT 许可证,详情请参阅 LICENSE 文件。
Scan to contact