From 157ac9ae9f1abbc6a3c5efb0b19e2c7ca7d6cb06 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Thu, 2 Jul 2026 23:14:32 +0300 Subject: [PATCH] chore: add MCP Registry submission files and per-client config snippets - Add server.json for official MCP Registry (io.github.commit-check/commit-check-mcp) - Add mcp-name HTML comment for PyPI ownership verification - Add MCP Registry and Glama badges to README header - Rewrite 'Use With An MCP Client' section with ready-to-use config snippets for: Claude Desktop, Claude Code CLI, Cursor, Windsurf, Cline, Continue.dev, Roo Code, and Zed - Recommend uvx as the primary zero-install runner - Add 'Published On' table with links to MCP Registry, Glama, PyPI - Add instructions for contributing to awesome-mcp-servers and Smithery --- README.md | 165 +++++++++++++++++++++++++++++++++++++++++++++++++--- server.json | 36 ++++++++++++ 2 files changed, 192 insertions(+), 9 deletions(-) create mode 100644 server.json diff --git a/README.md b/README.md index 2d25f74..e50cf02 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ # 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/) +[![MCP Registry](https://img.shields.io/badge/MCP%20Registry-io.github.commit--check/commit--check--mcp-7B3F00)](https://registry.modelcontextprotocol.io/) +[![Glama](https://img.shields.io/badge/Glama-commit--check--mcp-blue)](https://glama.ai/mcp/servers/github/commit-check/commit-check-mcp) Model Context Protocol (MCP) server for [commit-check](https://github.com/commit-check/commit-check). @@ -58,44 +62,174 @@ pip install -e . 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: +With `uvx` (recommended — no install needed): + +```bash +# 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 ```json { "mcpServers": { "commit-check": { - "command": "commit-check-mcp" + "command": "uvx", + "args": ["commit-check-mcp"] } } } ``` -If the client needs the full path to the executable, first locate it: +### Claude Code CLI -```bash -which commit-check-mcp +```json +{ + "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`: + +```json +{ + "mcpServers": { + "commit-check": { + "command": "uvx", + "args": ["commit-check-mcp"] + } + } +} +``` + +### Windsurf + +Add to your `~/.codeium/windsurf/mcp_config.json`: + +```json +{ + "mcpServers": { + "commit-check": { + "command": "uvx", + "args": ["commit-check-mcp"] + } + } +} +``` + +### Cline (VS Code) + +Add a new MCP server in the Cline extension settings: + +```json +{ + "mcpServers": { + "commit-check": { + "command": "uvx", + "args": ["commit-check-mcp"] + } + } +} ``` -Then use that absolute path in the client config. +### Continue.dev (VS Code / JetBrains) -Example using an absolute path: +Add to your `~/.continue/config.json`: + +```json +{ + "experimental": { + "mcpServers": { + "commit-check": { + "command": "uvx", + "args": ["commit-check-mcp"] + } + } + } +} +``` + +### Roo Code + +Add to your Roo Code MCP settings: ```json { "mcpServers": { "commit-check": { - "command": "/absolute/path/to/commit-check-mcp" + "command": "uvx", + "args": ["commit-check-mcp"] + } + } +} +``` + +### Zed + +Add to your `~/.config/zed/settings.json`: + +```json +{ + "mcp_servers": { + "commit-check": { + "command": "uvx", + "args": ["commit-check-mcp"] } } } ``` -For local development from this repository, that absolute path may point to something like `.venv/bin/commit-check-mcp`. +### Generic / Any MCP Client + +If your client does not support `uvx`, use `pip` and the direct path: + +```bash +pip install commit-check-mcp +which commit-check-mcp +``` + +Then use the absolute path in your config: + +```json +{ + "mcpServers": { + "commit-check": { + "command": "/path/to/commit-check-mcp" + } + } +} +``` ## Run Manually ```bash +# 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. @@ -205,3 +339,16 @@ Config precedence is: 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`](https://registry.modelcontextprotocol.io/) | +| **Glama.ai** | [`github/commit-check/commit-check-mcp`](https://glama.ai/mcp/servers/github/commit-check/commit-check-mcp) | +| **PyPI** | [`commit-check-mcp`](https://pypi.org/project/commit-check-mcp/) | + +To also add this server to your preferred directory, open a pull request at: + +- [punkpeye/awesome-mcp-servers](https://github.com/punkpeye/awesome-mcp-servers) — community-maintained list +- [Smithery.ai](https://smithery.ai/) — hosted MCP server registry diff --git a/server.json b/server.json new file mode 100644 index 0000000..674fd3d --- /dev/null +++ b/server.json @@ -0,0 +1,36 @@ +{ + "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json", + "name": "io.github.commit-check/commit-check-mcp", + "title": "commit-check MCP", + "description": "Validate commit messages, branch names, author info, push safety, and repository state with commit-check rules.", + "version": "0.1.4", + "repository": { + "url": "https://github.com/commit-check/commit-check-mcp", + "source": "github" + }, + "categories": [ + "developer-tools", + "version-control" + ], + "packages": [ + { + "registryType": "pypi", + "identifier": "commit-check-mcp", + "version": "0.1.4", + "transport": { + "type": "stdio", + "runtimeHint": "uvx commit-check-mcp" + } + } + ], + "tools": [ + "server_health", + "validate_commit_message", + "validate_branch_name", + "validate_push_safety", + "validate_author_info", + "validate_commit_context", + "validate_repository_state", + "describe_validation_rules" + ] +}