Skip to content

Correct README claims that do not match the repo - #192

Merged
a-akimov merged 1 commit into
modelcontextprotocol:mainfrom
olaservo:readme-followup-nits
Aug 29, 2026
Merged

Correct README claims that do not match the repo#192
a-akimov merged 1 commit into
modelcontextprotocol:mainfrom
olaservo:readme-followup-nits

Conversation

@olaservo

Copy link
Copy Markdown
Member

Motivation and Context

Follow-up to #188. That PR was a real improvement, and most of its claims check out. Five statements do not match the repository, so this corrects them.

License (the substantive one). The new License section said the repository is licensed under the MIT License. LICENSE is a transition file: new code contributions are Apache-2.0, documentation excluding specifications is CC-BY-4.0, and only earlier contributions whose authors have not consented to relicensing remain MIT. Replaced with a summary of the actual terms.

Rust floor. "Rust (stable)" understates it. rmcp, rmcp-macros, darling and time declare rust-version 1.88, and cargo metadata resolves both weather-server-rust and mcp-client-rust to 1.88. Someone on an older stable toolchain gets a build failure with no hint from the README. Now "Rust 1.88+".

Ruby floor. The aside "(3.3 also satisfies the gems)" is not accurate: anthropic requires >= 3.2.0 and mcp requires >= 2.7.0, so the gem floor is 3.2. Ruby 3.2 reached EOL on 2026-03-31, so it is not a version to point people at. CI runs 3.4, so the READMEs now just say 3.4+.

Client invocation. The root README says "All clients accept a path to a server to launch". The Go and Rust clients take a command plus arguments (exec.CommandContext(serverArgs[0], serverArgs[1:]...), and the Rust usage string is <server_script_or_binary> [args...]). The per-client READMEs get this right; only the summary line overreached.

Contributing conventions. The bullet "Keep commit messages about the change, not the tooling used to make it" is presented as being in line with the MCP contributing guidelines, which do not mention commit messages. Removed rather than left attributed to a source that does not say it. Added the AI_POLICY.md link that CONTRIBUTING.md points to, since that is where the disclosure expectations actually live.

Also trimmed trailing whitespace on two lines.

Everything else in #188 was verified and left alone, including the no-API-key behavior (true in all five clients), the cp .env.example .env instructions (present in exactly the four client directories that have the file), the hyphen/underscore split in the TypeScript tool names, and the Node/Python/Go floors.

How Has This Been Tested?

Documentation only, no code changed. Claims were checked against the repository: cargo metadata for the Rust MSRV, the rubygems API for required_ruby_version, endoflife.date for the Ruby EOL dates, .github/workflows/ci.yml for the CI versions, and the upstream CONTRIBUTING.md, AI_POLICY.md and CODE_OF_CONDUCT.md for the Contributing section.

Breaking Changes

No.

Types of changes

  • Documentation update

Additional context

Not addressed here: tests/smoke-test.sh still comments that the Go and Rust clients abort without a .env file and skips them. Both now exit cleanly without a key, so that comment is stale and the two clients could join the smoke coverage. That is a change to the tests rather than the docs, so it belongs in its own PR.

AI disclosure: written with Claude Code, which made the edits and ran the verification described above. I reviewed the result.

The License section named MIT. LICENSE is a transition file: new code
contributions are Apache-2.0, documentation excluding specifications is
CC-BY-4.0, and only earlier contributions without relicensing consent
stay MIT.

"Rust (stable)" understates the floor. rmcp, darling and time declare
rust-version 1.88, and cargo metadata resolves both crates to 1.88.

The Ruby aside said 3.3 also satisfies the gems. anthropic requires
>= 3.2.0 and mcp >= 2.7.0, so the gem floor was 3.2, and 3.2 reached EOL
on 2026-03-31. CI runs 3.4, which is what the READMEs now state.

The Go and Rust clients take a command plus arguments, not a path to a
server script.

Removed the commit-message convention, which is attributed to the MCP
contributing guidelines but does not appear in them. Added the
AI_POLICY.md link that CONTRIBUTING.md points to.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdvHa5MzDw33PEz3DbTaJD
@a-akimov
a-akimov merged commit 55f75f3 into modelcontextprotocol:main Aug 29, 2026
2 checks passed
@a-akimov

Copy link
Copy Markdown
Contributor

Thank you, @olaservo !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants