Gerrit Code Review

🚀 Gerrit Code Review MCP Server

This MCP server integrates with the Gerrit code review system, enabling AI assistants to view and evaluate code changes and their details through a simple interface.

🚀 Quick Start

Before using this server, ensure you meet the following prerequisites:

1. Install Python 3.8 or a higher version.
2. Make sure the Gerrit server has HTTPS access enabled.
3. Configure the correct HTTP credentials to access the Gerrit REST API.

✨ Features

The server offers a streamlined set of code review tools:

Fetch Change Details

fetch_gerrit_change(change_id: str, patchset_number: Optional[str] = None)

• Retrieve complete change information, including files and patch sets.
• Display detailed difference information for each modified file.
• Show file changes, insertions, and deletions.
• Support viewing specific patch sets.
• Return comprehensive change details, including:
  • Project and branch information.
  • Author and reviewer information.
  • Comments and review history.
  • File modification content and differences.
  • Current patch set information.

Compare Patch Set Differences

fetch_patchset_diff(change_id: str, base_patchset: str, target_patchset: str, file_path: Optional[str] = None)

• Compare differences between two patch sets.
• View differences for a specific file or all modified files.
• Analyze the evolution of code modifications across patch set versions.
• Track changes during the review iteration.

💻 Usage Examples

Basic Usage

Review a complete change:

# Fetch the latest patch set for change 23824
change = fetch_gerrit_change("23824")

Advanced Usage

Compare specific patch sets:

# Compare the differences between patch sets 1 and 2 for change 23824
diff = fetch_patchset_diff("23824", "1", "2")

Get the specific changes of a file between two patch sets:

# Get the modified content of the file_path file under change_id from the base to the target patch set
content_diff = fetch_patchset_diff(change_id, base, target, file_path=file_path)

📦 Installation

Via Smithery

Use the following command to install and manage this package:

smith install @cayirtepeomer/gerrit-code-review-mcp

Manual Installation

1. Clone the repository:

   git clone https://github.com/cayirtepeomer/gerrit-code-review-mcp.git
   cd gerrit-code-review-mcp
   

2. Install dependencies:

   pip install -r requirements.txt
   

📚 Documentation

Configuration Steps

Environment Variable Setup

Create a .env file in the project's root directory and add the following content:

GERRIT_HOST=your-gerrit-host
GERRIT_USERNAME=username
GERRIT_HTTP_PASSWORD=http-password

Replace your-gerrit-host with your Gerrit server address, e.g., https://gerrit.example.com

MCP Configuration

Create or modify the config.json file in the project's root directory and add the following content:

{
  "servers": {
    "gerrit-code-review-mcp": {
      "host": "localhost",
      "port": 8080,
      "ssl": false,
      "auth": {
        "type": "digest",
        "username": "your-username",
        "password": "your-http-password"
      }
    }
  }
}

Troubleshooting

If you encounter connection issues:

1. Ensure the HTTP password is set correctly.
2. Check the GERRIT_HOST setting.
3. Make sure the Gerrit server has HTTPS access enabled.
4. Test the connection using curl:

   curl -u "username:http-password" https://your-gerrit-host/a/changes/
   

5. Confirm that your account has access rights on Gerrit.

🔧 Technical Details

The server interacts with the Gerrit REST API, offering:

• Fast and reliable retrieval of change information.
• Security using HTTP digest authentication.
• Support for multiple Gerrit REST endpoints.
• A clean and easy - to - maintain codebase.
• HTTPS encryption to ensure communication security.

📄 License

This project is licensed under the MIT License.

🤝 Contribution Guidelines

We welcome all contributions! Please follow these steps:

1. Fork the repository.
2. Create a feature branch.
3. Make your modifications.
4. Submit a pull request.