Commit Helper

An MCP commit helper

python

0

GitHub Stars

python

Language

7 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "jolfr-commit-helper-mcp": {
      "command": "uv",
      "args": [
        "run",
        "python",
        "/path/to/commit-helper-mcp/main.py"
      ]
    }
  }
}

Commit Helper MCP is an MCP server that provides Commitizen functionality through MCP tools and resources. It lets you generate, validate, and work with conventional commit messages, while offering enhanced Git integration and health checks to streamline your development workflow.

How to use

You access Commit Helper MCP through an MCP client to generate, validate, and interact with commit messages. Use the provided tools to craft conventional commits, inspect message quality, and explore interactive questions that guide you toward the right subject, scope, and body.

How to install

Prerequisites: you need Python 3.13 or higher and the uv package manager.

Install from source by following these steps:

git clone <repository-url>
cd commit-helper-mcp

uv sync

uv pip install -e .

Configuration and usage notes

The server automatically detects your project’s Commitizen configuration from common configuration files, such as pyproject.toml, .cz.toml, .cz.json, or setup.cfg. You can view and refresh the current configuration using dedicated tools.

Manual configuration for Claude Desktop can be added to your Claude Desktop configuration file. Example entry:

{
  "mcpServers": {
    "commit_helper": {
      "command": "uv",
      "args": ["run", "python", "/path/to/commit-helper-mcp/main.py"],
      "cwd": "/path/to/commit-helper-mcp"
    }
  }
}

Troubleshooting and notes

If the server won’t start, verify you have Python 3.13+, install dependencies with uv sync, and ensure a valid Commitizen configuration exists. Check console logs for specific errors and refer to the health status when available.

If you encounter invalid commit messages, confirm the correct Commitizen plugin is configured and refresh the configuration after changes.

Available tools

generate_commit_message

Create a conventional commit message with specified type, subject, and optional scope, body, breaking change, and footer.

create_commit_message

Assemble a complete commit message from an answers dictionary containing all questions answered during message construction.

validate_commit_message

Check an existing commit message against the current commitizen plugin rules to ensure it conforms to the configured standard.

get_commit_types

Return the list of available commit types from the active Commitizen plugin along with their descriptions.

get_commit_questions

Provide the interactive questions used to guide the user in composing a commit message.

health_check

Return the health status of the Commitizen service and current configuration details.

refresh_configuration

Refresh the Commitizen configuration and reinitialize the service to apply changes.