Production-ready Model Context Protocol server for GitLab - 87 tools, 14 prompts, 13 resources
Project description
GitLab MCP Server
A production-ready Model Context Protocol (MCP) server that enables AI assistants like Claude Code to interact seamlessly with self-hosted GitLab instances.
Overview
The GitLab MCP Server provides a complete, type-safe interface for AI assistants to interact with GitLab, supporting:
- Repository Operations: Search code, browse files, manage branches and commits
- Issue Management: Create, update, close issues, manage labels and comments
- Merge Requests: Complete MR workflows including creation, review, approval, and merging
- CI/CD Pipelines: Monitor pipeline status, trigger jobs, access artifacts and logs
- Project Management: Milestones, labels, project settings
- Security & Compliance: Security scanning results, vulnerability tracking
- Advanced Features: Wikis, snippets, releases, user/group management
Built with strict Test-Driven Development (TDD) practices, featuring 1257 tests and 84% code coverage.
Transport Modes: stdio (default) and Streamable HTTP for remote clients Slim Mode: 3 meta-tools for 95% context reduction in LLM conversations
Features
Complete Tool Suite (87 Tools + 14 Prompts + 13 Resources)
Repository Tools (16)
- Search repositories, code, and commits
- Browse files and directory trees
- Create, update, delete files
- Manage branches and tags
- View commit history and diffs
- Compare branches
Issue Tools (8)
- Create, read, update, close issues
- Reopen closed issues
- Add comments and list comments
- Search and filter issues
Merge Request Tools (14)
- Create and manage merge requests
- Review code and add comments
- Approve and merge MRs
- Manage reviewers and assignees
- Track MR pipelines and changes
CI/CD Pipeline Tools (14)
- List and monitor pipelines
- Create, retry, cancel, delete pipelines
- View job logs and status
- Download and manage artifacts
- Retry and cancel jobs
- Play manual jobs
Project Management Tools (10)
- Create, search, and manage projects
- View project statistics
- Manage milestones
- Handle project members
Labels, Wikis, Snippets, Releases (19)
- Label management (4 tools)
- Wiki page operations (5 tools)
- Code snippets (5 tools)
- Release management (5 tools)
Users & Groups (6)
- User lookup and search
- Group listing and details
- Group member management
Meta Tools (3) - Slim Mode
discover_tools- List available tools by categoryget_tool_schema- Get JSON schema for any toolexecute_tool- Execute any tool dynamically
๐ Security First
- Personal Access Token (PAT) authentication
- Environment-based credential management
- SSL/TLS verification with custom certificate support
- Secure credential storage using
.envfiles (gitignored) - Token scope validation and error handling
๐ Performance Optimized
- Async/await throughout for non-blocking operations
- Efficient pagination for large datasets
- Configurable timeouts and retry logic
- Connection pooling via httpx
- Smart rate limiting awareness
Thoroughly Tested
- 1257 tests passing (100% pass rate)
- 84% code coverage (exceeds 80% requirement)
- Unit tests with mocked dependencies
- Integration tests with real GitLab API
- E2E tests validating full MCP protocol
- Type-safe with mypy validation
Quick Start
Prerequisites
- Python 3.10+
- GitLab instance (self-hosted CE/EE v15.0+ or GitLab.com)
- GitLab Personal Access Token with appropriate scopes
Installation
# Install from PyPI
pip install python-gitlab-mcp
# Or install from source
git clone https://github.com/wadew/gitlab-mcp.git
cd gitlab-mcp
pip install -e ".[dev]"
Configuration
1. Create Personal Access Token
Create a GitLab Personal Access Token with these scopes:
api- Full API accessread_repository- Read repository contentwrite_repository- Write repository content
See docs/user/installation.md for detailed instructions.
2. Configure Environment Variables
Create a .env file in your project:
# Required
GITLAB_URL=https://gitlab.example.com
GITLAB_TOKEN=glpat-xxxxxxxxxxxxxxxxxxxx
# Optional
GITLAB_DEFAULT_PROJECT=mygroup/myproject
GITLAB_TIMEOUT=30
GITLAB_VERIFY_SSL=true
3. Configure Claude Code
Add to your Claude Code MCP settings (~/.claude/mcp.json):
{
"mcpServers": {
"gitlab": {
"command": "python",
"args": ["-m", "gitlab_mcp.server"],
"env": {
"GITLAB_URL": "https://gitlab.example.com",
"GITLAB_TOKEN": "glpat-xxxxxxxxxxxxxxxxxxxx"
}
}
}
}
See docs/user/configuration.md for advanced configuration options.
Verify Installation
# Activate environment (if using venv)
source .venv/bin/activate
# Test GitLab connection
python -c "from gitlab_mcp.client import GitLabClient; client = GitLabClient(); print('Connected!')"
Usage Examples
Search Code Across Projects
# Claude Code can now do:
# "Search for 'authentication' in all repositories"
# This uses the MCP tool:
search_code(query="authentication", scope="global")
Create and Manage Issues
# "Create an issue for the login bug in my-project"
create_issue(
project_id="mygroup/my-project",
title="Fix login authentication bug",
description="Users cannot log in with SSO",
labels=["bug", "security"]
)
# "Add a comment to issue #42"
add_issue_comment(
project_id="mygroup/my-project",
issue_id=42,
body="This is related to the auth refactoring in MR !123"
)
Manage Merge Requests
# "Create a merge request from feature-branch to main"
create_merge_request(
project_id="mygroup/my-project",
source_branch="feature-branch",
target_branch="main",
title="Add OAuth2 support",
description="Implements OAuth2 authentication flow"
)
# "Approve merge request !25"
approve_merge_request(
project_id="mygroup/my-project",
mr_iid=25
)
Monitor CI/CD Pipelines
# "Show me the latest pipeline status"
list_pipelines(
project_id="mygroup/my-project",
limit=1
)
# "Get logs from the failed job"
get_job_log(
project_id="mygroup/my-project",
job_id=12345
)
See docs/user/usage_examples.md for comprehensive examples.
Documentation
User Documentation
- Installation Guide - Complete setup instructions
- Configuration Guide - Configuration options and best practices
- Usage Examples - Real-world usage scenarios
- Troubleshooting - Common issues and solutions
API Reference
- Tools Reference - Complete tool documentation (67 tools)
- GitLab API Mapping - GitLab API endpoint mapping
Architecture
- System Overview - High-level architecture
- Interfaces - Interface contracts
- Data Flow - How data flows through the system
Development
- Development Guide - Ground rules and TDD workflow
- Product Requirements - Complete feature specifications
- Session Management - Development session logs
Development
Setup Development Environment
# Clone repository
git clone https://github.com/wadew/gitlab-mcp.git
cd gitlab-mcp
# Install uv (fast Python package manager)
curl -LsSf https://astral.sh/uv/install.sh | sh
# Create virtual environment
uv venv
# Activate virtual environment
source .venv/bin/activate # On Windows: .venv\Scripts\activate
# Install development dependencies
uv pip install -e ".[dev]"
Running Tests
# Run all tests (unit + e2e)
pytest tests/unit/ tests/e2e/ -v
# Run with coverage
pytest tests/unit/ tests/e2e/ --cov=src/gitlab_mcp --cov-report=term-missing
# Run integration tests (requires GitLab instance)
source .env
export GITLAB_TEST_PROJECT_ID="mcps/gitlab_mcp"
pytest tests/integration/ -v -m integration
# Run specific test types
pytest tests/unit/ -v -m unit
pytest tests/e2e/ -v -m e2e
# Type checking
mypy src/gitlab_mcp
# Code formatting
black src/ tests/
# Linting
ruff check src/ tests/
Quality Standards
This project follows strict TDD practices:
- โ Tests first: Write failing tests, then implement
- โ 80%+ coverage: Minimum code coverage requirement
- โ 100% pass rate: All tests must pass before commit
- โ Type safety: Full mypy compliance
- โ Code quality: Black formatting, Ruff linting
- โ Documentation: Every function, class, and module
See CLAUDE.md for complete development guidelines.
Project Structure
gitlab_mcp/
โโโ src/gitlab_mcp/ # Source code
โ โโโ server.py # Main MCP server
โ โโโ config/ # Configuration management
โ โโโ client/ # GitLab API client wrapper
โ โโโ tools/ # MCP tool implementations (87 tools)
โ โโโ schemas/ # Pydantic data models
โ โโโ utils/ # Shared utilities
โโโ tests/ # Test suite (1257 tests)
โ โโโ unit/ # Unit tests (mocked)
โ โโโ integration/ # Integration tests (real API)
โ โโโ e2e/ # End-to-end MCP tests
โโโ docs/ # Documentation
โ โโโ user/ # User guides
โ โโโ api/ # API reference
โ โโโ architecture/ # System design
โ โโโ session_management/ # Development logs
โโโ CLAUDE.md # Development ground rules
โโโ next_session_plan.md # Current development state
โโโ pyproject.toml # Project metadata
Contributing
We welcome contributions! Before contributing:
- Read CLAUDE.md for development ground rules
- Check next_session_plan.md for current work
- Write tests first (TDD required)
- Ensure 80%+ coverage and 100% test pass rate
- Update documentation for user-facing changes
- Follow type hints and code quality standards
Commit Message Format
<type>(<scope>): <subject>
<body>
Coverage: X% (ยฑY%)
Tests: N passing
Types: feat, fix, docs, test, refactor, chore
Development Phases
- Phase 1: Foundation (Server, Config, Client, Auth)
- Phase 2: Repository & Issues Tools
- Phase 3: Merge Requests & Pipelines Tools
- Phase 4: Advanced Features (Security, Wikis, etc.)
- Phase 5: Meta-tools & Streamable HTTP Transport
- Phase 6: Public Release (PyPI + GitHub)
Roadmap
v1.1.0 (Next Release)
- Additional GitLab API coverage
- Performance optimization for large repositories
- Enhanced error messages and debugging tools
- WebSocket transport support
License
MIT License - See LICENSE file for details.
Support
- Issues: https://github.com/wadew/gitlab-mcp/issues
- Documentation: https://github.com/wadew/gitlab-mcp#documentation
- MCP Protocol: https://modelcontextprotocol.io
Acknowledgments
Built with:
- Model Context Protocol (MCP) - AI integration protocol
- python-gitlab - GitLab API client
- Pydantic - Data validation
- httpx - Async HTTP client
Built with strict TDD practices. 1257 tests. 84% coverage. Production-ready.
Made with care for the GitLab and AI communities.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file python_gitlab_mcp-1.0.0.tar.gz.
File metadata
- Download URL: python_gitlab_mcp-1.0.0.tar.gz
- Upload date:
- Size: 243.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
306607f16428533107e73ab19c509fa3c3f3a0a04bc92c9609cd955de931f43e
|
|
| MD5 |
daa604a32c78ffab0b224e4f9ddd4696
|
|
| BLAKE2b-256 |
f1de28e834810af20e582f9fb675552bdbd7b22ad2e6a58e538e5d9eb9a4529b
|
File details
Details for the file python_gitlab_mcp-1.0.0-py3-none-any.whl.
File metadata
- Download URL: python_gitlab_mcp-1.0.0-py3-none-any.whl
- Upload date:
- Size: 88.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9a37f83b55c094ca53cc33d7e7cd4fc77c3889d289ef206a81cc56fac6ec36fd
|
|
| MD5 |
0ee8324dc9ac7e9c67e1f3d688a23d05
|
|
| BLAKE2b-256 |
7dd638b7e130788968c4d63171d16bbd1955e7d19261856f382dcc723af84bae
|