🚀 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 文件。