Codebywaqas MRConfluenceLinker MCP Server

🚀 GitLab PR 分析 MCP 服务器

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

🚀 快速开始

此项目提供的 MCP 服务器能有效集成 GitLab 合并请求分析与 Confluence 文档。您可以按以下步骤快速开启使用：

1. 完成安装与配置。
2. 运行服务器并访问文档。
3. 利用 API 端点获取所需信息。

✨ 主要特性

• 获取详细信息：可获取 GitLab 的合并请求详细信息。
• 代码更改分析：对合并请求中的代码更改进行分析。
• 详细报告生成：生成的详细报告涵盖基本合并请求信息、代码更改统计信息、文件类型分析以及详细文件更改等内容。
• 结果存储：将分析结果存储在 Confluence 中。
• 全面日志记录：提供全面的日志记录，方便进行调试。

📦 安装指南

先决条件

• Python 3.8 或更高版本。
• 带有 API 访问权限的 GitLab 账户。
• Confluence 账户（可选，用于存储分析结果）。
• 具备访问所需 GitLab 项目的权限。

安装步骤

1. 克隆仓库：

git https://github.com/CodeByWaqas/MRConfluenceLinker-mcp-server.git
cd MRConfluenceLinker-mcp-server

2. 创建并激活虚拟环境：

python -m venv .venv
source .venv/bin/activate  # 在 Windows 上，使用：.venv\Scripts\activate

3. 安装依赖项：

pip install -r requirements.txt

或

uv add "mcp[cli]" python-gitlab python-dotenv atlassian-python-api

📚 详细文档

配置

创建 config.py 文件并添加以下内容：

# config.py
from mcp_server import resources

resources.initialize()

使用方法

1. 运行服务器：

uvicorn --reload mcp_server.server:app

2. 访问文档：在默认浏览器中打开 http://localhost:8000/docs

3. 使用 API 端点：

   • /api/v1/prs：获取所有合并请求。
   • /api/v1/pr/{pr_id}：获取特定合并请求的详细信息。

项目结构

MRConfluenceLinker-mcp-server/
├── src/                           # 源代码目录
│   └── 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/mcp_server/ 目录中

  • server.py：主要 MCP 服务器实现。
  • resources/client.py：客户端实现，包含 GitLab PR 集成。

• 配置文件：

  • requirements.txt：Python 包依赖项。
  • pyproject.toml：项目元数据和构建配置。
  • uv.lock：锁定的依赖版本。
  • .env.example：环境变量模板。

📄 许可证

本项目的许可证信息可查看项目根目录下的 LICENSE 文件。