Gitlab MR Confluence Linker

🚀 GitLab PR Analysis MCP Server

This project offers an MCP (Model Control Protocol) server that integrates GitLab merge request analysis with Confluence documentation. It enables you to pull merge request details from GitLab, analyze code changes, and store the results in Confluence pages.

🚀 Quick Start

The GitLab PR Analysis MCP Server allows you to efficiently analyze GitLab merge requests and store the results in Confluence. Follow the installation steps below to get started.

✨ Features

• Retrieve merge request details from GitLab.
• Analyze code changes within merge requests.
• Generate detailed reports containing:
  • Basic merge request information.
  • Code change statistics.
  • File type analysis.
  • Detailed file changes.
• Store analysis results in Confluence.
• Comprehensive logging for debugging purposes.

📦 Installation

Prerequisites

• Python 3.8 or higher.
• A GitLab account with API access.
• A Confluence account with REST API access.

Steps

1. Clone the project:

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

2. Activate a virtual environment (recommended):

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

3. Install dependencies:

   pip install -r requirements.txt
   

4. Configure environment variables:

   • Create a .env file and fill in the following:

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

5. Start the MCP server:

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

💻 Usage Examples

Configuration and Integration

• To integrate the MCP server with Claude Desktop, refer to the guidelines in the CONTRIBUTING.md file.
• Update the pyproject.toml and requirements.txt files to manage project dependencies.

Tool Usage

The main functions of the MCP server are as follows:

1. Pull Merge Request Details:

   • Use the GitLab API to obtain the list and detailed information of merge requests for a specified repository.

2. Analyze Code Changes:

   • Scan code changes in merge requests, generate difference reports, and identify potential issues.

3. Store in Confluence:

   • Automatically upload analysis results to Confluence pages for easy team collaboration and review.

📚 Documentation

Project Structure

MRConfluenceLinker-mcp-server/
├── src/                           # Source code directory
│   └── MRConfluenceLinker-mcp-server/  # Main server package
│       ├── resources/            # Resource module
│       │   ├── __init__.py
│       │   ├── client.py        # Client implementation / GitLab PR integration
│       ├── server.py            # Main server implementation
│       └── mcp_server.log       # Server logs
├── __pycache__/                 # Python cache files
├── .git/                        # Git repository
├── .gitignore                   # Git ignore rules
├── CONTRIBUTING.md              # Contribution guidelines
├── LICENSE                      # Project license
├── README.md                    # Project documentation
├── pyproject.toml              # Python project configuration
├── requirements.txt            # Project dependencies
└── uv.lock                     # Locked dependency versions file

Key Components

• Source Code: Located in the src/MRConfluenceLinker-mcp-server/ directory.

  • server.py: Main MCP server implementation.
  • resources/client.py: Client implementation, including GitLab PR integration.

• Configuration Files:

  • requirements.txt: Python package dependencies.
  • pyproject.toml: Project metadata and build configuration.
  • uv.lock: Locked dependency versions.
  • .env.example: Environment variable template.

📄 License

The project license information can be found in the LICENSE file.