🐍 Gerrit MCP Server
An MCP (Model Context Protocol) server for interacting with the Gerrit code
review system. This server allows a language model like Gemini to query changes,
retrieve details, and manage reviews by executing curl commands against the
Gerrit REST API.
This server can be run as a persistent HTTP server or on-demand via STDIO.
📚 Documentation
For detailed information, please see the documents in the docs/ directory:
- Configuration: A detailed guide to the
gerrit_config.jsonfile and all authentication methods. - Testing Guide: Instructions on how to run the unit, integration, and E2E tests.
- Gemini CLI Setup: How to configure the Gemini CLI to use this server.
- Best Practices: Tips for using the server effectively.
- Contributing: Guidelines for contributing to the project.
- Available Tools: A list of all available tools and their descriptions.
- Example Use Cases: Scenarios demonstrating how to use the server.
🚀 Getting Started
Install from PyPI (Recommended)
For quick use, install directly from PyPI:
# Run directly with uvx (no installation required)
uvx gerrit-mcp-server stdio
# Or install first
uv pip install gerrit-mcp-server
gerrit-mcp-server stdio
# Run HTTP server on specific port
gerrit-mcp-server --host localhost --port 6322
Configure the Server
Method 1: Global Configuration (Recommended)
Create a personal configuration file that works for all projects:
# Create config directory
mkdir -p ~/.config
# Copy config template
# If installing from source:
cp gerrit_mcp_server/gerrit_config.sample.json ~/.config/gerrit_config.json
# If installing from PyPI, manually create ~/.config/gerrit_config.json
vim ~/.config/gerrit_config.json
Save the following content to the configuration file and modify as needed:
{
"default_gerrit_base_url": "https://your-gerrit.com/",
"gerrit_hosts": [
{
"name": "My Gerrit",
"external_url": "https://your-gerrit.com/",
"authentication": {
"type": "http_basic",
"username": "your-username",
"auth_token": "your-http-password"
}
}
]
}
Configuration notes:
- Replace
your-usernamewith your Gerrit username - Replace
your-http-passwordwith your Gerrit HTTP password (generate in Gerrit Settings → HTTP Password) - Replace
https://your-gerrit.com/with your Gerrit server URL
After configuration, you can run the server directly:
gerrit-mcp-server stdio
Method 2: Project Configuration
Create gerrit_config.json in your project root directory:
cp gerrit_mcp_server/gerrit_config.sample.json ./gerrit_config.json
vim ./gerrit_config.json
Method 3: Temporary Configuration
Specify configuration file using command-line parameter:
gerrit-mcp-server --config /path/to/your/config.json stdio
💡 Tip: See the Configuration Guide for all authentication methods and advanced configuration options.
Install from Source
To install from source, follow these steps:
1. Prerequisites
Before you begin, ensure you have the following tools installed and available in your system's PATH.
- Python 3.11+: The build script requires a modern version of Python.
- curl: The standard command-line tool for transferring data with URLs.
2. Build the Environment
Run the build script from the root of the gerrit-mcp-server project directory.
This will create a Python virtual environment, install all dependencies, and
make the server ready to run.
./build-gerrit.sh
3. Configure the Server
You will need to create a gerrit_config.json file inside the
gerrit_mcp_server directory. Copy the provided sample file
gerrit_mcp_server/gerrit_config.sample.json and customize it for your
environment. See the Configuration Guide for
details on all available options.
cp gerrit_mcp_server/gerrit_config.sample.json gerrit_mcp_server/gerrit_config.json
4. Run the Server (HTTP Mode)
To run the server as a persistent background process, use the server.sh script:
- Start the server:
./server.sh start - Check the status:
./server.sh status - Stop the server:
./server.sh stop
For on-demand STDIO mode, please see the Gemini CLI Setup Guide.
Security
This is not an officially supported Google product. This project is not eligible for the Google Open Source Software Vulnerability Rewards Program.
Metadata
Release files for gerrit-mcp-server 1.0.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| gerrit_mcp_server-1.0.8.tar.gz | 23.3 kB | Without provenance | Details for gerrit_mcp_server-1.0.8.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| gerrit_mcp_server-1.0.8-py3-none-any.whl | Python 3 | none | any | Details for gerrit_mcp_server-1.0.8-py3-none-any.whl |
Total release size: 49.4 kB
Release files / gerrit_mcp_server-1.0.8.tar.gz
| Download URL | gerrit_mcp_server-1.0.8.tar.gz |
|---|---|
| Size | 23.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
75deaf7acd72f628f3b92a54c20cbdafb91c71128dfb15865a5db165da48c6a3
|
|
BLAKE2b-256 checksum How to use checksums |
f29141a3fc434d92c9a249775e21d93e7c55869ed64dafea9d1a19c2308a6a0e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.6
|
Release files / gerrit_mcp_server-1.0.8-py3-none-any.whl
| Download URL | gerrit_mcp_server-1.0.8-py3-none-any.whl |
|---|---|
| Size | 26.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
56dbea51c7b7f240660f8f7ad2936b02640bebaccc27352215daabdc9abe475d
|
|
BLAKE2b-256 checksum How to use checksums |
208f4a0b72c8090bddea6528b9507fad53319320288a52640c4f532330bf8532
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.6
|
Security for gerrit-mcp-server 1.0.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.