Skip to content

docs: add MCP Server to getting started page and homepage #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shenxianpeng merged 1 commit into from
Jun 21, 2026
Merged

docs: add MCP Server to getting started page and homepage #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,14 @@ Select the method that best fits your development workflow:

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

- :material-robot: **MCP Server**

---

MCP server exposing commit-check validations as structured tools for AI coding agents

**Perfect for:** Claude Code, Cursor, Copilot & any MCP-compatible AI agent

[Get started with MCP →](https://github.com/commit-check/commit-check-mcp){ .md-button .md-button--primary }

</div>
21 changes: 20 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ title: Commit Check

---

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

</div>

Expand Down Expand Up @@ -154,6 +154,25 @@ title: Commit Check
# And more...
```

=== "MCP Server"

Add to your AI coding agent's MCP config:

```json
{
"mcpServers": {
"commit-check": {
"command": "uvx",
"args": ["commit-check-mcp"]
}
}
}
```

Then your agent can validate commit messages, branch names, author info, and more with structured results.

[Learn more about MCP →](https://github.com/commit-check/commit-check-mcp)

---

<div class="community-section" markdown>
Expand Down