commit-check-mcp 0.1.1.post1.dev1__tar.gz → 0.1.3__tar.gz

commit_check_mcp-0.1.3/.github/dependabot.yml

@@ -0,0 +1,23 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: "monthly"
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: "monthly"
+    groups:
+      pip:
+        patterns:
+          - "*"

commit_check_mcp-0.1.3/.github/workflows/labeler.yml

@@ -0,0 +1,14 @@
+name: PR Autolabeler
+
+permissions:
+  contents: write
+  pull-requests: write
+
+on:
+  # pull_request event is required for autolabeler
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  draft-release:
+    uses: commit-check/.github/.github/workflows/pr-labeler.yml@main

{commit_check_mcp-0.1.1.post1.dev1 → commit_check_mcp-0.1.3}/.github/workflows/main.yml

@@ -35,7 +35,15 @@ jobs:
           python -m pip install -e .[dev]
 
       - name: Run tests
-        run: python -m pytest -q
+        run: python -m pytest -q --cov=src/commit_check_mcp --cov-report=xml
+
+      - name: Upload coverage reports to Codecov
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: commit-check/commit-check-mcp
+          files: ./coverage.xml
 
   build:
     runs-on: ubuntu-24.04

{commit_check_mcp-0.1.1.post1.dev1 → commit_check_mcp-0.1.3}/.github/workflows/release-drafter.yml

@@ -12,5 +12,5 @@ jobs:
   draft-release:
     permissions:
       contents: write
-      pull-requests: read
+      pull-requests: write
     uses: commit-check/.github/.github/workflows/release-drafter.yml@main

commit_check_mcp-0.1.3/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.4
+Name: commit-check-mcp
+Version: 0.1.3
+Summary: MCP server exposing commit-check validation tools
+Author-email: Xianpeng Shen <xianpeng.shen@gmail.com>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: commit-check<3,>=2.5.0
+Requires-Dist: mcp<2,>=1.27.0
+Provides-Extra: dev
+Requires-Dist: pytest<10,>=9.0.0; extra == "dev"
+Requires-Dist: pytest-cov<7,>=6.0.0; extra == "dev"
+Dynamic: license-file
+
+# commit-check-mcp
+
+[![PyPI version](https://img.shields.io/pypi/v/commit-check-mcp)](https://pypi.org/project/commit-check-mcp/)
+[![Python versions](https://img.shields.io/pypi/pyversions/commit-check-mcp)](https://pypi.org/project/commit-check-mcp/)
+[![Build](https://github.com/commit-check/commit-check-mcp/actions/workflows/main.yml/badge.svg)](https://github.com/commit-check/commit-check-mcp/actions/workflows/main.yml)
+[![Coverage](https://codecov.io/gh/commit-check/commit-check-mcp/graph/badge.svg)](https://codecov.io/gh/commit-check/commit-check-mcp)
+[![MCP server](https://img.shields.io/badge/MCP-server-0A7B83)](https://modelcontextprotocol.io/)
+
+Model Context Protocol (MCP) server for [commit-check](https://github.com/commit-check/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:
+
+```json
+{
+  "status": "pass|fail",
+  "checks": [
+    {
+      "check": "message",
+      "status": "pass|fail",
+      "value": "...",
+      "error": "...",
+      "suggest": "..."
+    }
+  ]
+}
+```
+
+## Installation
+
+```bash
+pip install commit-check-mcp
+```
+
+This installs the `commit-check-mcp` CLI entrypoint.
+
+For local development from this repository:
+
+```bash
+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:
+
+```json
+{
+  "mcpServers": {
+    "commit-check": {
+      "command": "commit-check-mcp"
+    }
+  }
+}
+```
+
+If the client needs the full path to the executable, first locate it:
+
+```bash
+which commit-check-mcp
+```
+
+Then use that absolute path in the client config.
+
+Example using an absolute path:
+
+```json
+{
+  "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
+
+```bash
+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:
+
+```json
+{
+  "message": "feat(api): add MCP validation tool",
+  "repo_path": "/path/to/repo"
+}
+```
+
+Validate the current repository branch using an explicit config file:
+
+```json
+{
+  "repo_path": "/path/to/repo",
+  "config_path": ".github/commit-check.toml"
+}
+```
+
+Validate the full repository state:
+
+```json
+{
+  "repo_path": "/path/to/repo",
+  "include_message": true,
+  "include_branch": true,
+  "include_author": true
+}
+```
+
+Inspect the final merged rules that will be applied:
+
+```json
+{
+  "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:
+
+```json
+{
+  "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

commit_check_mcp-0.1.3/README.md

@@ -0,0 +1,194 @@
+# commit-check-mcp
+
+[![PyPI version](https://img.shields.io/pypi/v/commit-check-mcp)](https://pypi.org/project/commit-check-mcp/)
+[![Python versions](https://img.shields.io/pypi/pyversions/commit-check-mcp)](https://pypi.org/project/commit-check-mcp/)
+[![Build](https://github.com/commit-check/commit-check-mcp/actions/workflows/main.yml/badge.svg)](https://github.com/commit-check/commit-check-mcp/actions/workflows/main.yml)
+[![Coverage](https://codecov.io/gh/commit-check/commit-check-mcp/graph/badge.svg)](https://codecov.io/gh/commit-check/commit-check-mcp)
+[![MCP server](https://img.shields.io/badge/MCP-server-0A7B83)](https://modelcontextprotocol.io/)
+
+Model Context Protocol (MCP) server for [commit-check](https://github.com/commit-check/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:
+
+```json
+{
+  "status": "pass|fail",
+  "checks": [
+    {
+      "check": "message",
+      "status": "pass|fail",
+      "value": "...",
+      "error": "...",
+      "suggest": "..."
+    }
+  ]
+}
+```
+
+## Installation
+
+```bash
+pip install commit-check-mcp
+```
+
+This installs the `commit-check-mcp` CLI entrypoint.
+
+For local development from this repository:
+
+```bash
+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:
+
+```json
+{
+  "mcpServers": {
+    "commit-check": {
+      "command": "commit-check-mcp"
+    }
+  }
+}
+```
+
+If the client needs the full path to the executable, first locate it:
+
+```bash
+which commit-check-mcp
+```
+
+Then use that absolute path in the client config.
+
+Example using an absolute path:
+
+```json
+{
+  "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
+
+```bash
+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:
+
+```json
+{
+  "message": "feat(api): add MCP validation tool",
+  "repo_path": "/path/to/repo"
+}
+```
+
+Validate the current repository branch using an explicit config file:
+
+```json
+{
+  "repo_path": "/path/to/repo",
+  "config_path": ".github/commit-check.toml"
+}
+```
+
+Validate the full repository state:
+
+```json
+{
+  "repo_path": "/path/to/repo",
+  "include_message": true,
+  "include_branch": true,
+  "include_author": true
+}
+```
+
+Inspect the final merged rules that will be applied:
+
+```json
+{
+  "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:
+
+```json
+{
+  "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

{commit_check_mcp-0.1.1.post1.dev1 → commit_check_mcp-0.1.3}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=77", "setuptools-scm", "wheel"]
+requires = ["setuptools>=77", "setuptools-scm"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -9,7 +9,20 @@ readme = "README.md"
 requires-python = ">=3.10"
 license = { text = "MIT" }
 authors = [
-  { name = "commit-check" }
+  { name = "Xianpeng Shen", email = "xianpeng.shen@gmail.com" }
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Software Development",
 ]
 dependencies = [
   "commit-check>=2.5.0,<3",
@@ -19,7 +32,8 @@ dynamic = ["version"]
 
 [project.optional-dependencies]
 dev = [
-  "pytest>=9.0.0,<10"
+  "pytest>=9.0.0,<10",
+  "pytest-cov>=6.0.0,<7"
 ]
 
 [project.scripts]