Skip to content

Commit 92f47d5

Browse files
authored
chore: add MCP Registry submission files and per-client config snippets (#12)
- 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
1 parent f785021 commit 92f47d5

2 files changed

Lines changed: 192 additions & 9 deletions

File tree

README.md

Lines changed: 156 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# commit-check-mcp
22

3+
<!-- mcp-name: io.github.commit-check/commit-check-mcp -->
4+
35
[![PyPI version](https://img.shields.io/pypi/v/commit-check-mcp)](https://pypi.org/project/commit-check-mcp/)
46
[![Python versions](https://img.shields.io/pypi/pyversions/commit-check-mcp)](https://pypi.org/project/commit-check-mcp/)
57
[![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)
68
[![Coverage](https://codecov.io/gh/commit-check/commit-check-mcp/graph/badge.svg)](https://codecov.io/gh/commit-check/commit-check-mcp)
79
[![MCP server](https://img.shields.io/badge/MCP-server-0A7B83)](https://modelcontextprotocol.io/)
10+
[![MCP Registry](https://img.shields.io/badge/MCP%20Registry-io.github.commit--check/commit--check--mcp-7B3F00)](https://registry.modelcontextprotocol.io/)
11+
[![Glama](https://img.shields.io/badge/Glama-commit--check--mcp-blue)](https://glama.ai/mcp/servers/github/commit-check/commit-check-mcp)
812

913
Model Context Protocol (MCP) server for [commit-check](https://github.com/commit-check/commit-check).
1014

@@ -58,44 +62,174 @@ pip install -e .
5862

5963
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.
6064

61-
Generic MCP client config:
65+
With `uvx` (recommended — no install needed):
66+
67+
```bash
68+
# Run once, no pip install required
69+
uvx commit-check-mcp
70+
```
71+
72+
> **Tip**: If `uv` is not installed, get it via `curl -LsSf https://astral.sh/uv/install.sh | sh`.
73+
74+
---
75+
76+
### Claude Desktop
6277

6378
```json
6479
{
6580
"mcpServers": {
6681
"commit-check": {
67-
"command": "commit-check-mcp"
82+
"command": "uvx",
83+
"args": ["commit-check-mcp"]
6884
}
6985
}
7086
}
7187
```
7288

73-
If the client needs the full path to the executable, first locate it:
89+
### Claude Code CLI
7490

75-
```bash
76-
which commit-check-mcp
91+
```json
92+
{
93+
"mcpServers": {
94+
"commit-check": {
95+
"command": "uvx",
96+
"args": ["commit-check-mcp"]
97+
}
98+
}
99+
}
100+
```
101+
102+
Add to your `~/.claude/settings.json` or project-level `.claude/settings.local.json`.
103+
104+
### Cursor
105+
106+
In Cursor, go to **Settings → Cursor Settings → MCP → Add new MCP server** and paste:
107+
108+
| Field | Value |
109+
|---|---|
110+
| **Name** | `commit-check` |
111+
| **Type** | `command` |
112+
| **Command** | `uvx commit-check-mcp` |
113+
114+
Or add to your project's `.cursor/mcp.json`:
115+
116+
```json
117+
{
118+
"mcpServers": {
119+
"commit-check": {
120+
"command": "uvx",
121+
"args": ["commit-check-mcp"]
122+
}
123+
}
124+
}
125+
```
126+
127+
### Windsurf
128+
129+
Add to your `~/.codeium/windsurf/mcp_config.json`:
130+
131+
```json
132+
{
133+
"mcpServers": {
134+
"commit-check": {
135+
"command": "uvx",
136+
"args": ["commit-check-mcp"]
137+
}
138+
}
139+
}
140+
```
141+
142+
### Cline (VS Code)
143+
144+
Add a new MCP server in the Cline extension settings:
145+
146+
```json
147+
{
148+
"mcpServers": {
149+
"commit-check": {
150+
"command": "uvx",
151+
"args": ["commit-check-mcp"]
152+
}
153+
}
154+
}
77155
```
78156

79-
Then use that absolute path in the client config.
157+
### Continue.dev (VS Code / JetBrains)
80158

81-
Example using an absolute path:
159+
Add to your `~/.continue/config.json`:
160+
161+
```json
162+
{
163+
"experimental": {
164+
"mcpServers": {
165+
"commit-check": {
166+
"command": "uvx",
167+
"args": ["commit-check-mcp"]
168+
}
169+
}
170+
}
171+
}
172+
```
173+
174+
### Roo Code
175+
176+
Add to your Roo Code MCP settings:
82177

83178
```json
84179
{
85180
"mcpServers": {
86181
"commit-check": {
87-
"command": "/absolute/path/to/commit-check-mcp"
182+
"command": "uvx",
183+
"args": ["commit-check-mcp"]
184+
}
185+
}
186+
}
187+
```
188+
189+
### Zed
190+
191+
Add to your `~/.config/zed/settings.json`:
192+
193+
```json
194+
{
195+
"mcp_servers": {
196+
"commit-check": {
197+
"command": "uvx",
198+
"args": ["commit-check-mcp"]
88199
}
89200
}
90201
}
91202
```
92203

93-
For local development from this repository, that absolute path may point to something like `.venv/bin/commit-check-mcp`.
204+
### Generic / Any MCP Client
205+
206+
If your client does not support `uvx`, use `pip` and the direct path:
207+
208+
```bash
209+
pip install commit-check-mcp
210+
which commit-check-mcp
211+
```
212+
213+
Then use the absolute path in your config:
214+
215+
```json
216+
{
217+
"mcpServers": {
218+
"commit-check": {
219+
"command": "/path/to/commit-check-mcp"
220+
}
221+
}
222+
}
223+
```
94224

95225
## Run Manually
96226

97227
```bash
228+
# If installed via pip
98229
commit-check-mcp
230+
231+
# Or via uvx (no install needed)
232+
uvx commit-check-mcp
99233
```
100234

101235
The server uses stdio transport, which is the recommended MCP default for local tool integrations.
@@ -205,3 +339,16 @@ Config precedence is:
205339
2. repository config loaded from `repo_path`
206340
3. `config_path` when explicitly provided
207341
4. inline `config` overrides passed to the tool
342+
343+
## Published On
344+
345+
| Directory | Link |
346+
|---|---|
347+
| **Official MCP Registry** | [`io.github.commit-check/commit-check-mcp`](https://registry.modelcontextprotocol.io/) |
348+
| **Glama.ai** | [`github/commit-check/commit-check-mcp`](https://glama.ai/mcp/servers/github/commit-check/commit-check-mcp) |
349+
| **PyPI** | [`commit-check-mcp`](https://pypi.org/project/commit-check-mcp/) |
350+
351+
To also add this server to your preferred directory, open a pull request at:
352+
353+
- [punkpeye/awesome-mcp-servers](https://github.com/punkpeye/awesome-mcp-servers) — community-maintained list
354+
- [Smithery.ai](https://smithery.ai/) — hosted MCP server registry

server.json

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
3+
"name": "io.github.commit-check/commit-check-mcp",
4+
"title": "commit-check MCP",
5+
"description": "Validate commit messages, branch names, author info, push safety, and repository state with commit-check rules.",
6+
"version": "0.1.4",
7+
"repository": {
8+
"url": "https://github.com/commit-check/commit-check-mcp",
9+
"source": "github"
10+
},
11+
"categories": [
12+
"developer-tools",
13+
"version-control"
14+
],
15+
"packages": [
16+
{
17+
"registryType": "pypi",
18+
"identifier": "commit-check-mcp",
19+
"version": "0.1.4",
20+
"transport": {
21+
"type": "stdio",
22+
"runtimeHint": "uvx commit-check-mcp"
23+
}
24+
}
25+
],
26+
"tools": [
27+
"server_health",
28+
"validate_commit_message",
29+
"validate_branch_name",
30+
"validate_push_safety",
31+
"validate_author_info",
32+
"validate_commit_context",
33+
"validate_repository_state",
34+
"describe_validation_rules"
35+
]
36+
}

0 commit comments

Comments
 (0)