Skip to content

docs: rename MCP server key to lowercase-hyphenated convention#2592

Open
mike-mo wants to merge 2 commits intomicrosoft:mainfrom
mike-mo:users/mike-mo/fix-server-name-convention
Open

docs: rename MCP server key to lowercase-hyphenated convention#2592
mike-mo wants to merge 2 commits intomicrosoft:mainfrom
mike-mo:users/mike-mo/fix-server-name-convention

Conversation

@mike-mo
Copy link
Copy Markdown

@mike-mo mike-mo commented May 6, 2026

Rename JSON key from "Azure MCP Server" to "azure-mcp-server" in all config examples across llms-install.md and servers/Azure.Mcp.Server/README.md.

Why

The previous name with spaces is rejected by GitHub Copilot CLI, which only allows alphanumeric characters, underscores, and hyphens in server names. Since llms-install.md is specifically designed for AI agents to follow when helping users install the MCP server, this results in broken configs being generated automatically.

The lowercase-hyphenated format also:

  • Aligns with MCP ecosystem conventions (github-mcp-server, kusto-mcp, adx-mcp-server)
  • Matches this project's own Copilot CLI E2E tester which uses "azure"
  • Is the safest common denominator across MCP clients (some are case-sensitive)

Fixes #2589

Rename JSON key from 'Azure MCP Server' to 'azure-mcp-server' in all
config examples. The previous name with spaces is rejected by GitHub
Copilot CLI which only allows alphanumeric characters, underscores,
and hyphens in server names.

The lowercase-hyphenated format also aligns with MCP ecosystem
conventions (e.g. github-mcp-server, kusto-mcp) and this project's
own Copilot CLI E2E tester which uses 'azure'.

Fixes microsoft#2589
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

Thank you for your contribution @mike-mo! We will review the pull request and get back to you soon.

Copy link
Copy Markdown
Contributor

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

Updates documentation config examples to use an MCP server key name compatible with GitHub Copilot CLI and other MCP clients by renaming "Azure MCP Server" to "azure-mcp-server".

Changes:

  • Renamed the JSON key used for the Azure MCP server in mcpServers/servers examples from "Azure MCP Server" to "azure-mcp-server".
  • Applied the rename across multiple setup pathways in the Azure MCP Server README (dnx, npx, uvx, docker) and in llms-install.md examples.

Invoking Livetests

Copilot submitted PRs are not trustworthy by default. Users with write access to the repo need to validate the contents of this PR before leaving a comment with the text /azp run mcp - pullrequest - live. This will trigger the necessary livetest workflows to complete required validation.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
llms-install.md Renames the documented server key in AI-agent-oriented config examples to azure-mcp-server.
servers/Azure.Mcp.Server/README.md Renames the documented server key across multiple manual setup configuration examples to azure-mcp-server.
Comments suppressed due to low confidence (1)

servers/Azure.Mcp.Server/README.md:206

  • In the Option 2 (npm/npx) mcp.json example, the command/args lines (and the closing ]) are not indented under the "azure-mcp-server" object like the surrounding examples. This makes the snippet harder to read and inconsistent with Options 1/3; consider re-indenting the JSON block to match the other configuration samples.
            "azure-mcp-server": {
            "command": "npx",
            "args": [
                "-y",
                "@azure/mcp@latest",
                "server",
                "start"
                ]

Copy link
Copy Markdown
Contributor

@jongio jongio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rename is correct and well-motivated. CI is green. One observation on coverage:

The same "Azure MCP Server" key name still appears in config examples in three other files:

  • AGENTS.md (line 577) - docker config example
  • CONTRIBUTING.md (lines 341, 482) - HTTP and docker config examples
  • servers/Azure.Mcp.Server/TROUBLESHOOTING.md (lines 772, 801, 1091) - docker and HTTP examples

Since this PR explicitly scopes to the two primary files (llms-install.md is the agent-facing install doc, README.md is the main setup guide), the scope is reasonable. But if you'd like to be thorough and catch all the spots in one pass, those three files have the same problem. Happy to leave that for a follow-up if you prefer.

Nit: the Option 2 (npx) JSON block in README.md has a pre-existing indentation issue where "command" and "args" aren't nested inside the server object. Not introduced by this PR - just noting it in case you want to fix it while you're in there.

…indentation

Extend the rename to config examples in AGENTS.md, CONTRIBUTING.md,
and TROUBLESHOOTING.md. Also fix pre-existing indentation in the
README.md Option 2 (npx) JSON block.

Prose references to the VS Code extension display name are left
unchanged as they refer to the marketplace listing, not a config key.
@mike-mo
Copy link
Copy Markdown
Author

mike-mo commented May 6, 2026

Thanks @jongio! Pushed a follow-up commit (f39852e) that addresses all 7 callouts:

  • Renamed the remaining "Azure MCP Server" config keys in AGENTS.md, CONTRIBUTING.md, and TROUBLESHOOTING.md (6 occurrences)
  • Fixed the pre-existing indentation in the README Option 2 (npx) JSON block

I left the prose references to "Azure MCP Server" in TROUBLESHOOTING.md and llms-install.md unchanged since those refer to the VS Code extension display name, not a config key.

Copy link
Copy Markdown
Contributor

@jongio jongio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addresses my previous feedback - all remaining instances renamed and indentation fixed. Looks good.

@github-project-automation github-project-automation Bot moved this from Untriaged to In Progress in Azure MCP Server May 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

llms-install.md and README use invalid MCP server name for GitHub Copilot CLI (spaces in JSON key)

3 participants