Skip to content

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 18, 2025
Merged

Conversation

SamMorrowDrums
Copy link
Collaborator

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.

@Copilot Copilot AI review requested due to automatic review settings June 18, 2025 11:02
@SamMorrowDrums SamMorrowDrums requested a review from a team as a code owner June 18, 2025 11:02
@SamMorrowDrums SamMorrowDrums merged commit 7da11c2 into main Jun 18, 2025
16 checks passed
@SamMorrowDrums SamMorrowDrums deleted the SamMorrowDrums-patch-3 branch June 18, 2025 11:02
Copy link
Contributor

@Copilot Copilot AI left a 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 servers and mcpServers blocks.
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 free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant