Skip to main content

MCP server exposing commit-check validation tools

Project description

commit-check-mcp

PyPI version Python versions Build Coverage MCP server MCP Registry Glama

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, push safety, 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_push_safety — validates that a push is not a force push
  • 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, author state, and optional push safety 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.

With uvx (recommended — no install needed):

# Run once, no pip install required
uvx commit-check-mcp

Tip: If uv is not installed, get it via curl -LsSf https://astral.sh/uv/install.sh | sh.


Claude Desktop

{
  "mcpServers": {
    "commit-check": {
      "command": "uvx",
      "args": ["commit-check-mcp"]
    }
  }
}

Claude Code CLI

{
  "mcpServers": {
    "commit-check": {
      "command": "uvx",
      "args": ["commit-check-mcp"]
    }
  }
}

Add to your ~/.claude/settings.json or project-level .claude/settings.local.json.

Cursor

In Cursor, go to Settings → Cursor Settings → MCP → Add new MCP server and paste:

Field Value
Name commit-check
Type command
Command uvx commit-check-mcp

Or add to your project's .cursor/mcp.json:

{
  "mcpServers": {
    "commit-check": {
      "command": "uvx",
      "args": ["commit-check-mcp"]
    }
  }
}

Windsurf

Add to your ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "commit-check": {
      "command": "uvx",
      "args": ["commit-check-mcp"]
    }
  }
}

Cline (VS Code)

Add a new MCP server in the Cline extension settings:

{
  "mcpServers": {
    "commit-check": {
      "command": "uvx",
      "args": ["commit-check-mcp"]
    }
  }
}

Continue.dev (VS Code / JetBrains)

Add to your ~/.continue/config.json:

{
  "experimental": {
    "mcpServers": {
      "commit-check": {
        "command": "uvx",
        "args": ["commit-check-mcp"]
      }
    }
  }
}

Roo Code

Add to your Roo Code MCP settings:

{
  "mcpServers": {
    "commit-check": {
      "command": "uvx",
      "args": ["commit-check-mcp"]
    }
  }
}

Zed

Add to your ~/.config/zed/settings.json:

{
  "mcp_servers": {
    "commit-check": {
      "command": "uvx",
      "args": ["commit-check-mcp"]
    }
  }
}

Generic / Any MCP Client

If your client does not support uvx, use pip and the direct path:

pip install commit-check-mcp
which commit-check-mcp

Then use the absolute path in your config:

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

Run Manually

# If installed via pip
commit-check-mcp

# Or via uvx (no install needed)
uvx 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_push_safety(push_refs?, 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?, include_push?)
  • 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
}

Validate push safety from git pre-push hook ref metadata:

{
  "repo_path": "/path/to/repo",
  "push_refs": "refs/heads/main abc123 refs/heads/main def456"
}

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
  • Validate push safety using pre-push ref metadata, or check the current branch against its upstream
  • 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,
  "include_push": 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

Published On

Directory Link
Official MCP Registry io.github.commit-check/commit-check-mcp
Glama.ai github/commit-check/commit-check-mcp
PyPI commit-check-mcp

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.8.tar.gz (86.5 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.8-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commit_check_mcp-0.1.8.tar.gz
  • Upload date:
  • Size: 86.5 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.8.tar.gz
Algorithm Hash digest
SHA256 3e42e18b9935d3623a3b99e9fea559975f1efaf15e569ca4a0b57b128ee6bdd2
MD5 8ed594ff4eeee7f02ef4b7437a47d886
BLAKE2b-256 e9f9f3cb98168fc6dc5ffd40af3caeb00dd1fdeaf07ac617c93b2807e95ff58c

See more details on using hashes here.

Provenance

The following attestation bundles were made for commit_check_mcp-0.1.8.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.8-py3-none-any.whl.

File metadata

File hashes

Hashes for commit_check_mcp-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 5c0677ac9dfb373f589f159ef14419ee34f4a8cb89d0796e0e5dcb9abc8b7f9e
MD5 08e9da24f35c023c3f5a9f3b9ca4f854
BLAKE2b-256 68c2e37c33080a59612dca870899f34b8b170a6be1d978b295b779811d4767a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for commit_check_mcp-0.1.8-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