docs: rebuild the README around setup, tools and results - #38
Merged
Merged
Conversation
The tools were listed twice (Features, Tool Usage), repo_path, config_path and config were explained twice, and the Published On table repeated what the badges already said. - The header matches the core and Action READMEs: the v4 banner (light and dark), the site's line, five badges in the brand colors and links to the docs, the CLI, the Action and the App. - Quick start leads with `claude mcp add`; the client table and the Continue entry are unchanged. - The tools are one table, with the shared arguments and the read-only/fetch annotations stated once underneath; the example payloads fold into <details>. - Results keep the shape and cut the prose to three points. - Installation, Run Manually and the dev install become Development. - The Glama link was a 404; it now points at the listing's current address. The mcp-name line the MCP Registry reads for PyPI ownership is kept as it was.
github-actions
Bot
added
the
documentation
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 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 #38 +/- ##
=======================================
Coverage 98.20% 98.20%
=======================================
Files 2 2
Lines 279 279
=======================================
Hits 274 274
Misses 5 5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
shenxianpeng
added a commit
to commit-check/commit-check.com
that referenced
this pull request
Sep 27, 2026
The *Add it to the agent* tabs in `docs/guides/mcp.md` had drifted from how the clients actually work, and from the commit-check-mcp README. ## What was wrong | Tab | Before | Now | |---|---|---| | Claude Code | JSON in `.claude/settings.local.json` or `~/.claude/settings.json`. Claude Code does not read MCP servers from there, so the server silently never loaded. commit-check/commit-check-mcp#36 fixed this in that repo's README. | `claude mcp add commit-check -- uvx commit-check-mcp`. The tab explains `--scope project` (a shared `.mcp.json` at the repository root) and `--scope user` (every project), and shows the `.mcp.json` block for writing it by hand. | | Zed | `mcp_servers` | `context_servers` | | VS Code | missing | New tab for `.vscode/mcp.json`, which uses the **`servers`** key, not `mcpServers` | | Other clients | Linked to the README's `#use-with-an-mcp-client`, a heading that commit-check/commit-check-mcp#38 removed | Links to `#where-each-client-keeps-it`, and adds Continue, whose entry is YAML | | Without uv | `which` only | Also mentions `where` on Windows | There is also one sentence outside the tabs. *"All tools are read-only"* was not true: `validate_push_safety` and `validate_repository_state` may run `git fetch` to resolve a SHA. The page now names those two and says what the fetch updates. The other six are annotated read-only for clients that auto-approve on that. ## Sources - **Claude Code:** `claude mcp add --help` (2.1.236) and the [MCP docs](https://code.claude.com/docs/en/mcp) for the scopes, where each one is stored, and the `.mcp.json` format. - **Zed:** the [MCP docs](https://zed.dev/docs/ai/mcp), which use `context_servers` with `command`, `args` and `env`. - **VS Code, Continue and the rest:** the client table in the commit-check-mcp README. - **Tool annotations:** `server.py` in commit-check-mcp (`read_only_hint = not fetches`). ## Checks - `mkdocs build --strict` passes (with `SOCIAL_CARDS=false`). The rendered page shows six tabs: Claude Code, Cursor, VS Code, Zed, the combined tab and Without uv. - The new README anchor exists on github.com/commit-check/commit-check-mcp. - `python -m pytest tests/ -q` passes with the released package installed (10 tests). The pins and the changelog were already at 2.18.1.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is the MCP part of the README pass, following commit-check/commit-check#587 (core) and commit-check/commit-check-action#293 (Action). The README drops from 289 lines to 197.
The old README had some repetition. The tools were listed twice, once under Features and again under Tool Usage.
repo_path,config_pathandconfigwere explained twice. The Published On table repeated what the badges already said.What changed
claude mcp add. The client table and the Continue entry are unchanged.<details>.fail/skip/warnmean, the fix-and-revalidate loop, and tool errors.glama.ai/mcp/servers/github/commit-check/commit-check-mcpreturns 404. The link now goes toglama.ai/mcp/servers/commit-check/commit-check-mcp, which is the listing's current address.The
mcp-nameline and its comment are kept exactly as they were, because the MCP Registry reads them to verify PyPI ownership.Checks
readme_renderer[md]) renders the file, including themcp-nameline.server.py:include_*default totrueexceptinclude_push, and the author falls back to git config.Summary by CodeRabbit
git fetch.