feat: add AGENTS.md, demo GIF, Smithery config, and README refresh#10
feat: add AGENTS.md, demo GIF, Smithery config, and README refresh#10shenxianpeng wants to merge 1 commit into
Conversation
- Add AGENTS.md with AI agent instructions for using commit-check-mcp tools - Add smithery.yaml for Smithery AI MCP directory listing - Add demo/demo.py (full) and demo/demo-compact.py (GIF-optimized) - Add demo/demo.tape and demo/demo.gif (vhs-generated terminal demo) - Rewrite README with AI-agent-first positioning, comparison to commitlint, Smithery badge, demo GIF, AGENTS.md reference, and development section Positioning: commit-check-mcp is the first MCP-native commit validation tool designed for AI coding agents, not human CI pipelines.
github-actions
Bot
added
documentation
📝 WalkthroughWalkthroughThis PR adds AI-agent documentation, Smithery integration, and interactive terminal demos to the commit-check-mcp repository. It provides instructions for agents, updates the README with Smithery badge and installation guidance, registers the server with Smithery.ai, and includes executable demos showcasing all validation features. ChangesDocumentation, Smithery Integration, and Demo Implementation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #10 +/- ##
=======================================
Coverage 66.02% 66.02%
=======================================
Files 2 2
Lines 209 209
=======================================
Hits 138 138
Misses 71 71 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@demo/demo.py`:
- Around line 159-160: The two print statements using unnecessary f-strings
(print(f" AI agents to validate commits, branches, authors,") and print(f"
push safety, and repository state.")) should be changed to plain string literals
by removing the leading "f" so they are print(" AI agents to validate commits,
branches, authors,") and print(" push safety, and repository state."); locate
and update these exact print calls in demo.py.
In `@README.md`:
- Line 16: The heading "### Why this vs commitlint?" is incorrectly h3 and
should be h2 to preserve Markdown hierarchy; change that line to "## Why this vs
commitlint?" (update the heading level for the heading text "Why this vs
commitlint?") so the document flows from h1 to h2 properly and maintains
accessibility and structure.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 19233b6a-f026-4504-a9de-56f51b71298d
⛔ Files ignored due to path filters (1)
demo/demo.gifis excluded by!**/*.gif
📒 Files selected for processing (6)
AGENTS.mdREADME.mddemo/demo-compact.pydemo/demo.pydemo/demo.tapesmithery.yaml
| print(f" AI agents to validate commits, branches, authors,") | ||
| print(f" push safety, and repository state.") |
There was a problem hiding this comment.
Remove unnecessary f-string prefixes.
These f-strings contain no placeholders and should be regular strings.
🧹 Proposed fix
- print(f" AI agents to validate commits, branches, authors,")
- print(f" push safety, and repository state.")
+ print(" AI agents to validate commits, branches, authors,")
+ print(" push safety, and repository state.")📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| print(f" AI agents to validate commits, branches, authors,") | |
| print(f" push safety, and repository state.") | |
| print(" AI agents to validate commits, branches, authors,") | |
| print(" push safety, and repository state.") |
🧰 Tools
🪛 Ruff (0.15.14)
[error] 159-159: f-string without any placeholders
Remove extraneous f prefix
(F541)
[error] 160-160: f-string without any placeholders
Remove extraneous f prefix
(F541)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@demo/demo.py` around lines 159 - 160, The two print statements using
unnecessary f-strings (print(f" AI agents to validate commits, branches,
authors,") and print(f" push safety, and repository state.")) should be changed
to plain string literals by removing the leading "f" so they are print(" AI
agents to validate commits, branches, authors,") and print(" push safety, and
repository state."); locate and update these exact print calls in demo.py.
|
|
||
| **commit-check-mcp** is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that exposes [commit-check](https://github.com/commit-check/commit-check) validations as structured tools. AI agents call these tools to validate commit messages, branch names, author info, push safety, and repository state — every tool returns pass/fail results with actionable suggestions. | ||
|
|
||
| ### Why this vs commitlint? |
There was a problem hiding this comment.
Fix heading level to maintain proper document structure.
The heading jumps from h1 to h3, skipping h2. For correct Markdown hierarchy and accessibility, this should be an h2 heading.
📝 Proposed fix
-### Why this vs commitlint?
+## Why this vs commitlint?📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Why this vs commitlint? | |
| ## Why this vs commitlint? |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 16-16: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 16, The heading "### Why this vs commitlint?" is
incorrectly h3 and should be h2 to preserve Markdown hierarchy; change that line
to "## Why this vs commitlint?" (update the heading level for the heading text
"Why this vs commitlint?") so the document flows from h1 to h2 properly and
maintains accessibility and structure.
2 participants
Summary
This PR positions commit-check-mcp for the MCP ecosystem explosion by adding:
1. AGENTS.md — AI Agent Instructions
The key differentiator vs commitlint. Tells AI coding agents (Claude Code, Cursor, Copilot, etc.) how to use commit-check-mcp tools effectively. Documents:
2. Demo GIF
Terminal demo generated with vhs, showing all validation tools in action:
3. smithery.yaml
Configuration for the Smithery MCP server registry. Allows users to install via
npx @smithery-ai/cli install commit-check-mcp.4. README Refresh
Why this matters
The MCP ecosystem is exploding right now. commitlint is designed for human CI pipelines — this tool is uniquely positioned as the first commit validation tool built for AI agents via MCP.
Getting listed on Smithery/mcp.so early provides organic discovery during this ecosystem growth window.
Files changed
AGENTS.mdsmithery.yamldemo/demo.pydemo/demo-compact.pydemo/demo.tapedemo/demo.gifREADME.mdSummary by CodeRabbit
Documentation
New Features