GitLab MR Confluence Linker

🚀 GitLab PR 分析 MCP 服务器

该项目提供了一个 MCP（模型控制协议）服务器，将 GitLab 合并请求分析与 Confluence 文档进行了集成。借助此服务器，您能够从 GitLab 拉取合并请求的详细信息、分析代码更改，并将分析结果存储在 Confluence 页面中。

✨ 主要特性

• 可从 GitLab 获取合并请求详细信息。
• 能够分析合并请求中的代码更改。
• 生成详细报告，涵盖以下内容：
  • 基本合并请求信息
  • 代码更改统计信息
  • 文件类型分析
  • 详细的文件更改
• 把分析结果存储在 Confluence 中。
• 具备全面的日志记录功能，方便进行调试。

📦 安装指南

1. 克隆该项目：

   git clone https://git.example.com/gitlab-pr-analysis.git
   cd gitlab-pr-analysis
   

2. 激活虚拟环境（推荐）：

   python -m venv env
   source env/bin/activate  # 在 macOS/Linux 上
   .\env\Scripts\activate  # 在 Windows 上
   

3. 安装依赖项：

   pip install -r requirements.txt
   

4. 配置环境变量：

   • 创建 .env 文件并填写以下内容：

     GITHUB_TOKEN=your_github_token
     CONFLUENCE_BASE_URL=https://your.confluence.url
     CONFLUENCE_API_KEY=your_confluence_api_key
     

5. 启动 MCP 服务器：

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

💻 使用示例

配置与集成

• 若要将 MCP 服务器与 Claude Desktop 集成，请参考 CONTRIBUTING.md 文件中的指导。
• 可更新 pyproject.toml 和 requirements.txt 文件来管理项目依赖关系。

工具使用

以下是 MCP 服务器的主要功能：

1. 拉取合并请求详细信息：
   • 使用 GitLab API 获取指定仓库的合并请求列表和详细信息。
2. 分析代码更改：
   • 扫描合并请求中的代码变更，生成差异报告并识别潜在问题。
3. 存储到 Confluence：
   • 将分析结果自动上传到 Confluence 页面中，便于团队协作和审查。

📚 详细文档

项目结构

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                    # 项目文档
├── pyproject.toml              # Python 项目配置
├── requirements.txt            # 项目依赖项
└── uv.lock                     # 依赖版本锁定文件

关键组件

• 源代码：位于 src/MRConfluenceLinker-mcp-server/ 目录中
  • server.py：主 MCP 服务器实现
  • resources/client.py：客户端实现，包含 GitLab PR 集成
• 配置文件：
  • requirements.txt：Python 包依赖项
  • pyproject.toml：项目元数据和构建配置
  • uv.lock：锁定的依赖版本
  • .env.example：环境变量模板

📄 许可证

请查看项目中的 LICENSE 文件以获取详细的许可信息。