commit-check MCP

在糟糕的提交合并之前发现问题 — 在 AI Agent 中完成。

文档 · 规则 · CLI · GitHub Action · GitHub App

Commit Check 的 Model Context Protocol 服务，为团队和 AI Agent 提供代码化的提交策略。它会将 CI 强制执行的规则交给你的编码 Agent：在提交或推送之前，Agent 会检查提交信息、分支名和作者；如果修正方式明确，还会提供可应用的修正。

快速开始

claude mcp add commit-check -- uvx commit-check-mcp

其他客户端都使用相同的命令启动。请注册以下对象：

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

还没有 uv？运行 curl -LsSf https://astral.sh/uv/install.sh | sh 安装，或者使用 pip install commit-check-mcp，如以下最后一行所示。

各客户端的配置位置

Continue 的完整 config.yaml 配置项（Continue 要求提供 name、version 和 schema；如果只向现有文件添加 mcpServers 片段，可省略这些字段；也可以将其保存为 .continue/mcpServers/ 中的独立文件）：

name: commit-check
version: 0.0.1
schema: v1
mcpServers:
  - name: commit-check
    command: uvx
    args: ["commit-check-mcp"]

工具

除 server_health 外，每个工具还接受：

• repo_path — 应用其 cchk.toml / commit-check.toml 的仓库。 工具读取 git 状态时，该路径必须是 git 仓库；如果你自行传入所有值，则只需提供一个包含配置文件的普通目录。
• config_path — 用来替代仓库自身配置的配置文件路径； 相对路径以 repo_path 为基准解析。
• config — 内联覆盖项，会合并到现有配置之上，例如 {"commit": {"require_body": true}}。

没有工具会更改工作树或提交。validate_push_safety 和 validate_repository_state 可能会运行 git fetch 来解析 SHA，因此只有这两个工具会被标记为非只读；依赖 MCP 工具提示进行门控的客户端可以自动批准其他六个工具。

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

{
  "repo_path": "/path/to/repo",
  "include_push": true
}

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

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

结果

每个 validate_* 工具都会返回 commit-check --format json 输出的结构：

{
  "status": "pass|fail|skip",
  "warnings": 0,
  "checks": [
    {
      "rule_id": "CC001",
      "check": "message",
      "status": "pass|fail|warn|skip",
      "value": "...",
      "error": "...",
      "suggest": "...",
      "fix": "...",
      "docs_url": "https://commit-check.com/rules/#cc001",
      "reason": ""
    }
  ]
}

• 只有 fail 表示拒绝。skip 表示未验证任何内容——绝不能将其视为通过；warn 会报告出来，但不会导致运行失败。使用 commit-check 2.19.0 或更高版本时，跳过的检查会在 reason 中说明原因，例如 "author dependabot[bot] is in [commit].ignore_authors"；较旧版本会省略该字段。
• 如果结果为 fail，则原样应用非空的 fix；否则遵循 suggest，然后重新验证。服务端指令会教 Agent 按此循环操作。
• 如果调用完全无法运行——例如 message 为空、repo_path 不存在，或在需要 git 仓库时该路径不是 git 仓库、配置无效，或 push_refs 中的 SHA 无法解析——则会返回指出问题的 MCP 工具错误，而非通过结果。

开发

pip install -e .[dev]
python -m pytest

该服务端使用 stdio 通信，因此由 MCP 客户端启动；手动运行 uvx commit-check-mcp 仅用于确认其能够启动。

社区

问题和想法请提交到 Discussions， Bug 请提交到 Issues。 版本发布遵循语义化版本。基于 MIT License发布。

_{mcp-name: io.github.commit-check/commit-check-mcp}