MCP READMEs simplified and deduplicated with official documentation#220
Merged
patricksullivansf merged 2 commits intomainfrom Feb 27, 2026
Merged
MCP READMEs simplified and deduplicated with official documentation#220patricksullivansf merged 2 commits intomainfrom
patricksullivansf merged 2 commits intomainfrom
Conversation
yhsieh1
approved these changes
Feb 27, 2026
Contributor
yhsieh1
left a comment
yhsieh1
left a comment
There was a problem hiding this comment.
It looks great and centralizes the doc to reference official github page.
patricksullivansf
force-pushed
the
psullivan.mcpSimmplifyReadme
branch
from
449c9cd to
a129452
Compare
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.
Summary
The goal of these changes is to reduce the documentation maintenance burden for tool developers and tool testing. This PR brings the MCP sub-repo README in-line with the scope and style of the CLI README. It is especially focused on de-duplicating detailed tool descriptions and configuration descriptions that are already detailed in the official user guide and the tool jsDocs. It also further consolidates the MCP development guidelines into the CONTRIBUTING doc as the source of truth.
Testing
View the new markdown
The above links go directly to this PR commit
a1294521879799b022a0c607405be260a1527c9aDependencies
3pl-approvedis set by a maintainerpnpm test)pnpm run format)