docs: rename MCP server key to lowercase-hyphenated convention#2592
docs: rename MCP server key to lowercase-hyphenated convention#2592mike-mo wants to merge 2 commits intomicrosoft:mainfrom
Conversation
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
|
Thank you for your contribution @mike-mo! We will review the pull request and get back to you soon. |
There was a problem hiding this comment.
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/serversexamples 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.mdexamples.
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.jsonexample, thecommand/argslines (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"
]
jongio
left a comment
There was a problem hiding this comment.
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 exampleCONTRIBUTING.md(lines 341, 482) - HTTP and docker config examplesservers/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.
|
Thanks @jongio! Pushed a follow-up commit (
I left the prose references to "Azure MCP Server" in |
jongio
left a comment
There was a problem hiding this comment.
Addresses my previous feedback - all remaining instances renamed and indentation fixed. Looks good.
Rename JSON key from
"Azure MCP Server"to"azure-mcp-server"in all config examples acrossllms-install.mdandservers/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.mdis 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:
github-mcp-server,kusto-mcp,adx-mcp-server)"azure"Fixes #2589