docs: add CLI command flags reference to README#2192
Open
Br1an67 wants to merge 1 commit intomodelcontextprotocol:mainfrom
Open
docs: add CLI command flags reference to README#2192Br1an67 wants to merge 1 commit intomodelcontextprotocol:mainfrom
Br1an67 wants to merge 1 commit intomodelcontextprotocol:mainfrom
Conversation
Document all available flags for `mcp run`, `mcp dev`, and `mcp install` subcommands, including the `-t/--transport` flag for `mcp run` which was previously undocumented. Fixes modelcontextprotocol#457
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
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
Adds a "CLI Command Flags" reference section to
README.v2.md, documenting all available flags for themcp run,mcp dev, andmcp installsubcommands.Fixes #457
Problem
The
-t/--transportflag formcp run(and other CLI flags) were not documented in the README, making it difficult for users and LLMs to discover them without reading the source code.Changes
README.v2.md: Added a "CLI Command Flags" subsection under "Running Your Server" with tables documenting all flags for each subcommand, including usage examples.