Skip to content

Commit c0d33d0

Browse files
authored
docs: add MCP Server to getting started page and homepage (#8)
Adds the [commit-check-mcp](https://github.com/commit-check/commit-check-mcp) MCP server to the site, covering: ### Changes **Getting Started page** — Added a 4th grid card for the MCP Server, targeting AI coding agents (Claude Code, Cursor, Copilot, etc.). **Homepage** — Updated the "Works Everywhere" card description to include MCP server. Added a new Quick Start tab with an example MCP config snippet. ### Why The `commit-check-mcp` package is a mature part of the commit-check ecosystem with a dedicated repo and PyPI package. It was missing from the docs despite being listed under the org repos. This makes it discoverable to users looking for AI-agent-friendly commit validation.
1 parent ea86934 commit c0d33d0

2 files changed

Lines changed: 30 additions & 1 deletion

File tree

docs/getting-started.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,14 @@ Select the method that best fits your development workflow:
3838

3939
[Get started with CLI →](https://commit-check.github.io/commit-check/){ .md-button .md-button--primary }
4040

41+
- :material-robot: **MCP Server**
42+
43+
---
44+
45+
MCP server exposing commit-check validations as structured tools for AI coding agents
46+
47+
**Perfect for:** Claude Code, Cursor, Copilot & any MCP-compatible AI agent
48+
49+
[Get started with MCP →](https://github.com/commit-check/commit-check-mcp){ .md-button .md-button--primary }
50+
4151
</div>

docs/index.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ title: Commit Check
3030

3131
---
3232

33-
GitHub Actions, pre-commit hooks, or the command line — integrate Commit Check anywhere your code lives.
33+
GitHub Actions, pre-commit hooks, command line, or MCP server — integrate Commit Check anywhere your code lives.
3434

3535
</div>
3636

@@ -154,6 +154,25 @@ title: Commit Check
154154
# And more...
155155
```
156156

157+
=== "MCP Server"
158+
159+
Add to your AI coding agent's MCP config:
160+
161+
```json
162+
{
163+
"mcpServers": {
164+
"commit-check": {
165+
"command": "uvx",
166+
"args": ["commit-check-mcp"]
167+
}
168+
}
169+
}
170+
```
171+
172+
Then your agent can validate commit messages, branch names, author info, and more with structured results.
173+
174+
[Learn more about MCP →](https://github.com/commit-check/commit-check-mcp)
175+
157176
---
158177

159178
<div class="community-section" markdown>

0 commit comments

Comments
 (0)