docs: fix stale API references and broken links across READMEs#119
Merged
Conversation
Cross-checked every README against current source: mcp-cli/README.md listed a removed `stats` command while omitting the `server` and `setup` subcommands; mcp-core/README.md referenced a nonexistent Error::InvalidConfiguration variant (actual: ConfigError); mcp-files/README.md called a nonexistent export_to_disk method (actual: export_to_filesystem[_with_options]); runtime/README.md used a stale .js import extension and a generate invocation without --from-config; root README.md linked to examples/SKILL.md and docs/adr/, both removed in earlier releases.
github-actions
Bot
added
area: cli
bug-ops
enabled auto-merge (squash)
July 8, 2026 23:19
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.
Summary
Audited every README in the workspace (root + 7 crates + examples + runtime) against the current source and fixed real drift found along the way:
crates/mcp-cli/README.md: documented astatscommand that no longer exists; added the missingserverandsetupsubcommandscrates/mcp-core/README.md: example usedError::InvalidConfigurationwhich does not exist (actual variant isConfigError)crates/mcp-files/README.md: example calledexport_to_disk, which does not exist (actual API isexport_to_filesystem/export_to_filesystem_with_options)runtime/README.md: import example used a stale.jsextension for the runtime bridge (actual template emits.ts);generateexample omitted the required--from-configflagREADME.md: Documentation section linked toexamples/SKILL.mdanddocs/adr/, both removed in earlier releasesAll other crate READMEs (mcp-codegen, mcp-introspector, mcp-skill, mcp-server) and examples/README.md were checked against their public API and found accurate; no changes needed there.
Test plan