fix: correct the client setup in the MCP guide - #48
Merged
Merged
Conversation
The Claude Code tab told readers to put the server in .claude/settings.local.json or ~/.claude/settings.json. Claude Code does not read MCP servers from settings.json, so that config was silently ignored. commit-check/commit-check-mcp#36 fixed the same mistake in that README; the site kept it. - Claude Code: `claude mcp add commit-check -- uvx commit-check-mcp`, with --scope project for a shared .mcp.json or --scope user for every project, and the .mcp.json block for writing it by hand. - Zed: the key is context_servers, not mcp_servers. - VS Code: a tab of its own, since its .vscode/mcp.json takes the servers key rather than mcpServers. - The catch-all tab pointed at the README's #use-with-an-mcp-client, which commit-check/commit-check-mcp#38 renamed; it now links #where-each-client-keeps-it and names Continue, whose entry is YAML. - "All tools are read-only" was not true: the two push checks may run git fetch to resolve a SHA. The page now says which two, and what that updates. Checked against Claude Code's `claude mcp add --help` and its MCP docs, Zed's MCP docs, and the commit-check-mcp README.
✅ Deploy Preview for commit-check ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Review limit reachedNext included review available in 23 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
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 |
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
1 participant
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.
The Add it to the agent tabs in
docs/guides/mcp.mdhad drifted from how the clients actually work, and from the commit-check-mcp README.What was wrong
.claude/settings.local.jsonor~/.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.jsonat the repository root) and--scope user(every project), and shows the.mcp.jsonblock for writing it by hand.mcp_serverscontext_servers.vscode/mcp.json, which uses theserverskey, notmcpServers#use-with-an-mcp-client, a heading that commit-check/commit-check-mcp#38 removed#where-each-client-keeps-it, and adds Continue, whose entry is YAMLwhichonlywhereon WindowsThere is also one sentence outside the tabs. "All tools are read-only" was not true:
validate_push_safetyandvalidate_repository_statemay rungit fetchto 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 mcp add --help(2.1.236) and the MCP docs for the scopes, where each one is stored, and the.mcp.jsonformat.context_serverswithcommand,argsandenv.server.pyin commit-check-mcp (read_only_hint = not fetches).Checks
mkdocs build --strictpasses (withSOCIAL_CARDS=false). The rendered page shows six tabs: Claude Code, Cursor, VS Code, Zed, the combined tab and Without uv.python -m pytest tests/ -qpasses with the released package installed (10 tests). The pins and the changelog were already at 2.18.1.