- Notifications
You must be signed in to change notification settings - Fork1.4k
docs: suggest shorter name for server#546
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Merged
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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
7da11c2 intomain 16 checks passed
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Pull Request Overview
This PR shortens the configured server key from "github-remote" to "github" in JSON examples to reduce name length risks.
- Replace all instances of
"github-remote"with"github"in README JSON snippets. - Ensure consistent server identifier usage in both
serversandmcpServersblocks.
Comments suppressed due to low confidence (2)
README.md:43
- [nitpick] The server identifier "github" is very generic and might conflict with other entries; consider a concise yet more specific key (e.g., "github-mcp") to maintain clarity and avoid collisions.
"github": {README.md:43
- Since the server key has changed from "github-remote" to "github", please add a migration note or update references to ensure users adjust existing configurations accordingly, including any mentions in docs/host-integration.md.
"github": {Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
None yet
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.
Long names increase the risk that the max length for tool names will be breached as many clients add the user specified name as part of the key.