Skip to main content

MCP server exposing commit-check validation tools

Project description

commit-check-mcp

PyPI version Python versions Build Coverage MCP server

Model Context Protocol (MCP) server for commit-check.

commit-check-mcp exposes commit-check as local MCP tools so an MCP client can validate commit messages, branch names, author info, and repository state.

Features

This MCP server exposes commit-check validations as MCP tools:

  • server_health — returns server/sdk versions
  • validate_commit_message — validates a commit message
  • validate_branch_name — validates a branch name or the current repo branch
  • validate_author_info — validates author name/email or the repo's git author config
  • validate_commit_context — runs combined checks in one call
  • validate_repository_state — validates latest commit, current branch, and author state for a repo
  • describe_validation_rules — returns the effective config and enabled rules after merging defaults and repo config

All validation tools return the same structured commit-check result shape:

{
  "status": "pass|fail",
  "checks": [
    {
      "check": "message",
      "status": "pass|fail",
      "value": "...",
      "error": "...",
      "suggest": "..."
    }
  ]
}

Installation

pip install commit-check-mcp

This installs the commit-check-mcp CLI entrypoint.

For local development from this repository:

pip install -e .

Use With An MCP Client

This server runs over stdio, so it is meant to be launched by an MCP client rather than used as a long-running HTTP service.

Generic MCP client config:

{
  "mcpServers": {
    "commit-check": {
      "command": "commit-check-mcp"
    }
  }
}

If the client needs the full path to the executable, first locate it:

which commit-check-mcp

Then use that absolute path in the client config.

Example using an absolute path:

{
  "mcpServers": {
    "commit-check": {
      "command": "/absolute/path/to/commit-check-mcp"
    }
  }
}

For local development from this repository, that absolute path may point to something like .venv/bin/commit-check-mcp.

Run Manually

commit-check-mcp

The server uses stdio transport, which is the recommended MCP default for local tool integrations.

Tool Usage

After the client starts the server, it will expose these tools:

  • server_health: returns server, SDK, and dependency versions
  • validate_commit_message(message, config?, repo_path?, config_path?)
  • validate_branch_name(branch?, config?, repo_path?, config_path?)
  • validate_author_info(author_name?, author_email?, config?, repo_path?, config_path?)
  • validate_commit_context(message?, branch?, author_name?, author_email?, config?, repo_path?, config_path?)
  • validate_repository_state(repo_path?, config?, config_path?, include_message?, include_branch?, include_author?)
  • describe_validation_rules(config?, repo_path?, config_path?)

The common optional arguments are:

  • repo_path: repository directory to validate against
  • config_path: explicit TOML config file; relative paths resolve from repo_path
  • config: ad-hoc config overrides merged on top of defaults and repo config

Common Examples

Validate a commit message using repo-local rules:

{
  "message": "feat(api): add MCP validation tool",
  "repo_path": "/path/to/repo"
}

Validate the current repository branch using an explicit config file:

{
  "repo_path": "/path/to/repo",
  "config_path": ".github/commit-check.toml"
}

Validate the full repository state:

{
  "repo_path": "/path/to/repo",
  "include_message": true,
  "include_branch": true,
  "include_author": true
}

Inspect the final merged rules that will be applied:

{
  "repo_path": "/path/to/repo",
  "config": {
    "commit": {
      "require_body": true
    }
  }
}

Repository-Aware Validation

commit-check is most useful when it runs against a real git repository and its cchk.toml or commit-check.toml file. This MCP server now supports that directly:

  • repo_path — run git-based validations against a specific repository
  • config_path — point to an explicit TOML config file; relative paths are resolved from repo_path
  • config — apply ad-hoc overrides on top of defaults and repo config

Typical patterns:

  • Validate an explicit message with a repository's rules
  • Validate the current repository state without passing message/branch/author values manually
  • Inspect which rules are actually enabled after config merging

Example payload for a repository-wide validation:

{
  "repo_path": "/path/to/repo",
  "include_message": true,
  "include_branch": true,
  "include_author": true
}

Config precedence is:

  1. commit-check built-in defaults
  2. repository config loaded from repo_path
  3. config_path when explicitly provided
  4. inline config overrides passed to the tool

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

commit_check_mcp-0.1.3.tar.gz (80.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

commit_check_mcp-0.1.3-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file commit_check_mcp-0.1.3.tar.gz.

File metadata

  • Download URL: commit_check_mcp-0.1.3.tar.gz
  • Upload date:
  • Size: 80.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for commit_check_mcp-0.1.3.tar.gz
Algorithm Hash digest
SHA256 ca76fe79b7cf6f68cba4f28bffe13d7d3c9d75472d82798cd7bad7e5a561b104
MD5 0b5497de9065cae21861c73f3de84d74
BLAKE2b-256 c53a580051163a562628b0f4786049ba9bf660fb31f074b40aef0677206c7ec0

See more details on using hashes here.

Provenance

The following attestation bundles were made for commit_check_mcp-0.1.3.tar.gz:

Publisher: publish.yml on commit-check/commit-check-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file commit_check_mcp-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for commit_check_mcp-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 18e089e7549ab40f9791d81cbbe538c4f850e235b7ae17018557b27a2c28dcb7
MD5 2cb8b66e55c80046baf3870cbc013464
BLAKE2b-256 3aeb29833e3db4d81ee5561f42dad1c7614e55fe9a7c06914d5812b0d2132e71

See more details on using hashes here.

Provenance

The following attestation bundles were made for commit_check_mcp-0.1.3-py3-none-any.whl:

Publisher: publish.yml on commit-check/commit-check-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page