Skip to content

docs: lead the README client example with a URL, not the server object - #3315

Merged
maxisbey merged 3 commits into
mainfrom
docs/readme-client-url-wording
Aug 16, 2026
Merged

maxisbey merged 3 commits into
mainfrom
docs/readme-client-url-wording

docs: lead the README client example with a URL, not the server object

d64e623
Select commit
Loading
Failed to load commit list.
Claude / Claude Code Review completed Aug 16, 2026 in 5m 56s

Code review found 2 potential issues

Found 3 candidates, confirmed 2. See review comments for details.

Details

Severity Count
🔴 Important 0
🟡 Nit 2
🟣 Pre-existing 0
Severity File:Line Issue
🟡 Nit README.md:110 [quality] nit: the rewritten README client example is an inline, untracked code block instead of using the repo's snippe
🟡 Nit src/mcp/cli/cli.py:0 [quality] pre-existing: 'mcp run --help' still shows a stale docstring claiming a "Module approach: server.py - runs the

Annotations

Check warning on line 110 in README.md

See this annotation in the file changed.

@claude claude / Claude Code Review

[quality] nit: the rewritten README client example is an inline, untracked code block instead of using the repo's snippet-source mechanism (a `docs_src/` module wrapped in `<!-- snippet-source ... -->` markers), which the server block directly above (line

[quality] nit: the rewritten README client example is an inline, untracked code block instead of using the repo's snippet-source mechanism (a `docs_src/` module wrapped in `<!-- snippet-source ... -->` markers), which the server block directly above (lines 53-73, sourcing docs_src/index/tutorial001.py) already uses and which the pre-commit hook `scripts/update_readme_snippets.py --check` enforces; near-identical client code already lives in docs_src/client_transports/tutorial002.py.