|
1 | 1 | # commit-check-mcp |
2 | 2 |
|
| 3 | +<!-- mcp-name: io.github.commit-check/commit-check-mcp --> |
| 4 | + |
3 | 5 | [](https://pypi.org/project/commit-check-mcp/) |
4 | 6 | [](https://pypi.org/project/commit-check-mcp/) |
5 | 7 | [](https://github.com/commit-check/commit-check-mcp/actions/workflows/main.yml) |
6 | 8 | [](https://codecov.io/gh/commit-check/commit-check-mcp) |
7 | 9 | [](https://modelcontextprotocol.io/) |
| 10 | +[](https://registry.modelcontextprotocol.io/) |
| 11 | +[](https://glama.ai/mcp/servers/github/commit-check/commit-check-mcp) |
8 | 12 |
|
9 | 13 | Model Context Protocol (MCP) server for [commit-check](https://github.com/commit-check/commit-check). |
10 | 14 |
|
@@ -58,44 +62,174 @@ pip install -e . |
58 | 62 |
|
59 | 63 | 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. |
60 | 64 |
|
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 |
62 | 77 |
|
63 | 78 | ```json |
64 | 79 | { |
65 | 80 | "mcpServers": { |
66 | 81 | "commit-check": { |
67 | | - "command": "commit-check-mcp" |
| 82 | + "command": "uvx", |
| 83 | + "args": ["commit-check-mcp"] |
68 | 84 | } |
69 | 85 | } |
70 | 86 | } |
71 | 87 | ``` |
72 | 88 |
|
73 | | -If the client needs the full path to the executable, first locate it: |
| 89 | +### Claude Code CLI |
74 | 90 |
|
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 | +} |
77 | 155 | ``` |
78 | 156 |
|
79 | | -Then use that absolute path in the client config. |
| 157 | +### Continue.dev (VS Code / JetBrains) |
80 | 158 |
|
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: |
82 | 177 |
|
83 | 178 | ```json |
84 | 179 | { |
85 | 180 | "mcpServers": { |
86 | 181 | "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"] |
88 | 199 | } |
89 | 200 | } |
90 | 201 | } |
91 | 202 | ``` |
92 | 203 |
|
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 | +``` |
94 | 224 |
|
95 | 225 | ## Run Manually |
96 | 226 |
|
97 | 227 | ```bash |
| 228 | +# If installed via pip |
98 | 229 | commit-check-mcp |
| 230 | + |
| 231 | +# Or via uvx (no install needed) |
| 232 | +uvx commit-check-mcp |
99 | 233 | ``` |
100 | 234 |
|
101 | 235 | The server uses stdio transport, which is the recommended MCP default for local tool integrations. |
@@ -205,3 +339,16 @@ Config precedence is: |
205 | 339 | 2. repository config loaded from `repo_path` |
206 | 340 | 3. `config_path` when explicitly provided |
207 | 341 | 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 |
0 commit comments