You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+120-3Lines changed: 120 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
Model Context Protocol (MCP) server for [commit-check](https://github.com/commit-check/commit-check).
4
4
5
+
`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.
6
+
5
7
## Features
6
8
7
9
This MCP server exposes commit-check validations as MCP tools:
@@ -31,19 +33,127 @@ All validation tools return the same structured commit-check result shape:
31
33
}
32
34
```
33
35
34
-
## Install
36
+
## Installation
37
+
38
+
```bash
39
+
pip install commit-check-mcp
40
+
```
41
+
42
+
This installs the `commit-check-mcp` CLI entrypoint.
43
+
44
+
For local development from this repository:
35
45
36
46
```bash
37
47
pip install -e .
38
48
```
39
49
40
-
## Run
50
+
## Use With An MCP Client
51
+
52
+
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.
53
+
54
+
Generic MCP client config:
55
+
56
+
```json
57
+
{
58
+
"mcpServers": {
59
+
"commit-check": {
60
+
"command": "commit-check-mcp"
61
+
}
62
+
}
63
+
}
64
+
```
65
+
66
+
If the client needs the full path to the executable, first locate it:
67
+
68
+
```bash
69
+
which commit-check-mcp
70
+
```
71
+
72
+
Then use that absolute path in the client config.
73
+
74
+
Example using an absolute path:
75
+
76
+
```json
77
+
{
78
+
"mcpServers": {
79
+
"commit-check": {
80
+
"command": "/absolute/path/to/commit-check-mcp"
81
+
}
82
+
}
83
+
}
84
+
```
85
+
86
+
For local development from this repository, that absolute path may point to something like `.venv/bin/commit-check-mcp`.
87
+
88
+
## Run Manually
41
89
42
90
```bash
43
91
commit-check-mcp
44
92
```
45
93
46
-
The server runs over stdio transport (recommended MCP default for local tool integrations).
94
+
The server uses stdio transport, which is the recommended MCP default for local tool integrations.
95
+
96
+
## Tool Usage
97
+
98
+
After the client starts the server, it will expose these tools:
99
+
100
+
-`server_health`: returns server, SDK, and dependency versions
0 commit comments