GerritCodeReview/gerrit-mcp-server
If you are the rightful owner of gerrit-mcp-server and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to dayong@mcphub.com.
The Gerrit MCP Server is a Model Context Protocol server designed to interact with the Gerrit code review system, enabling language models to manage code reviews via the Gerrit REST API.
🐍 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:
- : A detailed guide to the
gerrit_config.jsonfile and all authentication methods. - : Instructions on how to run the unit, integration, and E2E tests.
- : How to configure the Gemini CLI to use this server.
- : Tips for using the server effectively.
- : Guidelines for contributing to the project.
- : A list of all available tools and their descriptions.
- : Scenarios demonstrating how to use the server.
🚀 Getting Started
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 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 .
Security
This is not an officially supported Google product. This project is not eligible for the Google Open Source Software Vulnerability Rewards Program.