Codebywaqas MRConfluenceLinker MCP Server

🚀 GitLab PR Analysis MCP Server

This project provides an MCP (Model Control Protocol) server that integrates GitLab merge request analysis with Confluence documentation. The server allows you to retrieve merge request details, analyze code changes, and store the results in Confluence pages.

🚀 Quick Start

This MCP server enables seamless integration between GitLab merge request analysis and Confluence documentation. It offers a range of features to streamline the analysis process and store results effectively.

✨ Features

• Retrieve detailed information about GitLab merge requests.
• Analyze code changes within merge requests.
• Generate comprehensive reports, including:
  • Basic merge request information.
  • Code change statistics.
  • File type analysis.
  • Detailed file changes.
• Store analysis results in Confluence.
• Maintain comprehensive logs for debugging purposes.

📦 Installation

Prerequisites

• Python 3.8 or higher.
• A GitLab account with API access.
• A Confluence account (optional, for storing analysis results).
• Access to the required GitLab projects.

Steps

1. Clone the repository:

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

2. Create and activate a virtual environment:

python -m venv .venv
source .venv/bin/activate  # On Windows, use: .venv\Scripts\activate

3. Install dependencies:

pip install -r requirements.txt

Or

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

📚 Documentation

Configuration

Create a config.py file and add the following content:

# config.py
from mcp_server import resources

resources.initialize()

Usage Examples

Basic Usage

1. Run the server:

uvicorn --reload mcp_server.server:app

2. Access the documentation: Open http://localhost:8000/docs in your default browser.

3. Use the API endpoints:

   • /api/v1/prs: Retrieve all merge requests.
   • /api/v1/pr/{pr_id}: Retrieve detailed information about a specific merge request.

🔧 Technical Details

Project Structure

MRConfluenceLinker-mcp-server/
├── src/                           # Source code directory
│   └── 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

Key Components

• Source Code: Located in the src/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

This project is licensed under the terms specified in the LICENSE file.