-
Notifications
You must be signed in to change notification settings - Fork 339
Update azmcp-commands.md with usage clarifications #1353
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
Conversation
Clarified usage instructions for the Azure MCP Server in both local and container environments. Added warnings regarding command and entrypoint configurations.
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 updates the Azure MCP Server documentation to clarify the distinction between using azmcp as a local CLI tool versus running the official Azure MCP Server container image. It adds important guidance to prevent common deployment errors when using container platforms like Azure Container Apps.
Key Changes
- Added a new subsection explaining the difference between local CLI usage and container image deployment
- Provided explicit warnings against overriding container entrypoints with
azmcpcommands - Included best practices for customizing container deployments
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@microsoft-github-policy-service agree /azp run mcp - pullrequest - live |
|
Hi @JasonYeMSFT — could you please take a look at #1353 when you have a moment? Summary:
No code changes expected; just seeking a quick review/ACK so we can merge. Thanks! |
JasonYeMSFT
left a comment
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.
Please adjust the part about customizing arguments and consider adding a link to the Dockerfile to help explain things.
docs(Azure.Mcp.Server): clarify container vs local azmcp usage; link to root Dockerfile and show ENTRYPOINT
|
Thanks for the review, @JasonYeMSFT — I addressed the CHANGES_REQUESTED:
Please take a look and let me know if this addresses your feedback |
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
Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
/azp run mcp - pullrequest - live Sorry @JasonYeMSFT , but this formating looks better now. Please, re-approve. Thanks |
|
Commenter does not have sufficient privileges for PR 1353 in repo microsoft/mcp |
|
/azp run mcp - pullrequest - live |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
@JasonYeMSFT Do you know why this isn't merged yet ? |
|
The build gets canceled by the owner of the live test pipeline. Let me ask to see what happened. |
|
@JasonYeMSFT Any news on this one, please?? |
Co-authored-by: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com>
Co-authored-by: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com>
|
@alzimmermsft thanks for your suggestions. |
|
@alzimmermsft Can you approved it now, please? |
|
@jpsantoscosta The PR build failed because there is a link that doesn't point to meaningful content. |
|
@JasonYeMSFT True Jason, its refers to the repository name here https://mcr.microsoft.com/en-us/artifact/mar/azure-sdk/azure-mcp/tags It should be fine now. please review and approved if ok, please. |
|
/azp run mcp - pullrequest - live |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
The PR is approved and has passed all status checks. Can you please merge it when convenient? Thanks |
Clarified usage instructions for the Azure MCP Server in both local and container environments. Added warnings regarding command and entrypoint configurations.
This PR updates the documentation in
servers/Azure.Mcp.Server/docs/azmcp-commands.mdto clarify how the Azure MCP Server should be used in local CLI mode versus when running the official Azure MCP Server container image.GitHub issue number?
[[Link to the GitHub issue this PR addresses](https://github.com/issues/mentioned?issue=microsoft%7Cmcp%7C1341)]Pre-merge Checklist
servers/Azure.Mcp.Server/CHANGELOG.mdand/orservers/Fabric.Mcp.Server/CHANGELOG.mdfor product changes (features, bug fixes, UI/UX, updated dependencies)servers/Azure.Mcp.Server/README.mdand/orservers/Fabric.Mcp.Server/README.mddocumentationeng/scripts/Process-PackageReadMe.ps1. See Package README/servers/Azure.Mcp.Server/docs/azmcp-commands.mdand/or/docs/fabric-commands.md.\eng\scripts\Update-AzCommandsMetadata.ps1to update tool metadata in azmcp-commands.md (required for CI)ToolDescriptionEvaluatorand obtained a score of0.4or more and a top 3 ranking for all related test promptsconsolidated-tools.json/servers/Azure.Mcp.Server/docs/e2eTestPrompts.mdcrypto mining, spam, data exfiltration, etc.)/azp run mcp - pullrequest - liveto run Live Test Pipeline