Skip to content

Conversation

@jpsantoscosta
Copy link
Contributor

@jpsantoscosta jpsantoscosta commented Dec 10, 2025

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.md to 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

  • Required for All PRs
    • Read contribution guidelines
    • PR title clearly describes the change
    • Commit history is clean with descriptive messages (cleanup guide)
    • Added comprehensive tests for new/modified functionality
    • Updated servers/Azure.Mcp.Server/CHANGELOG.md and/or servers/Fabric.Mcp.Server/CHANGELOG.md for product changes (features, bug fixes, UI/UX, updated dependencies)
  • For MCP tool changes:
    • One tool per PR: This PR adds or modifies only one MCP tool for faster review cycles
    • Updated servers/Azure.Mcp.Server/README.md and/or servers/Fabric.Mcp.Server/README.md documentation
    • Validate README.md changes using script at eng/scripts/Process-PackageReadMe.ps1. See Package README
    • Updated command list in /servers/Azure.Mcp.Server/docs/azmcp-commands.md and/or /docs/fabric-commands.md
    • Run .\eng\scripts\Update-AzCommandsMetadata.ps1 to update tool metadata in azmcp-commands.md (required for CI)
    • For new or modified tool descriptions, ran ToolDescriptionEvaluator and obtained a score of 0.4 or more and a top 3 ranking for all related test prompts
    • For tools with new names, including new tools or renamed tools, update consolidated-tools.json
    • For new tools associated with Azure services or publicly available tools/APIs/products, add URL to documentation in the PR description
  • Extra steps for Azure MCP Server tool changes:
    • Updated test prompts in /servers/Azure.Mcp.Server/docs/e2eTestPrompts.md
    • 👉 For Community (non-Microsoft team member) PRs:
      • Security review: Reviewed code for security vulnerabilities, malicious code, or suspicious activities before running tests (crypto mining, spam, data exfiltration, etc.)
      • Manual tests run: added comment /azp run mcp - pullrequest - live to run Live Test Pipeline

Clarified usage instructions for the Azure MCP Server in both local and container environments. Added warnings regarding command and entrypoint configurations.
Copy link
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

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 azmcp commands
  • Included best practices for customizing container deployments

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@jpsantoscosta
Copy link
Contributor Author

@microsoft-github-policy-service agree

/azp run mcp - pullrequest - live

@jpsantoscosta
Copy link
Contributor Author

Hi @JasonYeMSFT — could you please take a look at #1353 when you have a moment?

Summary:

  • Documentation update to servers/Azure.Mcp.Server/docs/azmcp-commands.md clarifying azmcp CLI vs container usage
  • I’ve signed the CLA: "@microsoft-github-policy-service agree"
  • Triggered live tests: "/azp run mcp - pullrequest - live"

No code changes expected; just seeking a quick review/ACK so we can merge. Thanks!

Copy link
Member

@JasonYeMSFT JasonYeMSFT left a 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.

@github-project-automation github-project-automation bot moved this from Untriaged to In Progress in Azure MCP Server Dec 10, 2025
docs(Azure.Mcp.Server): clarify container vs local azmcp usage; link to root Dockerfile and show ENTRYPOINT
@jpsantoscosta
Copy link
Contributor Author

jpsantoscosta commented Dec 11, 2025

Thanks for the review, @JasonYeMSFT — I addressed the CHANGES_REQUESTED:

  • Clarified the section about customizing startup arguments (ENTRYPOINT vs CMD).
  • Added the image ENTRYPOINT snippet so readers can see what the container runs by default:
    ENTRYPOINT ["./server-binary", "server", "start"]
  • Replaced the broken path with a link to the repository root Dockerfile (there’s no Dockerfile under servers/Azure.Mcp.Server).

Please take a look and let me know if this addresses your feedback

Copy link
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

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

jpsantoscosta and others added 2 commits December 12, 2025 15:53
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@jpsantoscosta
Copy link
Contributor Author

/azp run mcp - pullrequest - live

Sorry @JasonYeMSFT , but this formating looks better now. Please, re-approve.

Thanks

@azure-pipelines
Copy link

Commenter does not have sufficient privileges for PR 1353 in repo microsoft/mcp

@JasonYeMSFT
Copy link
Member

/azp run mcp - pullrequest - live

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@jpsantoscosta
Copy link
Contributor Author

@JasonYeMSFT Do you know why this isn't merged yet ?

@JasonYeMSFT JasonYeMSFT added the documentation Improvements or additions to documentation label Dec 15, 2025
@JasonYeMSFT
Copy link
Member

The build gets canceled by the owner of the live test pipeline. Let me ask to see what happened.

@jpsantoscosta
Copy link
Contributor Author

jpsantoscosta commented Dec 22, 2025

@JasonYeMSFT Any news on this one, please??

jpsantoscosta and others added 2 commits January 6, 2026 22:31
Co-authored-by: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com>
Co-authored-by: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com>
@jpsantoscosta
Copy link
Contributor Author

@alzimmermsft thanks for your suggestions.

@jpsantoscosta
Copy link
Contributor Author

@alzimmermsft Can you approved it now, please?

@JasonYeMSFT
Copy link
Member

@jpsantoscosta The PR build failed because there is a link that doesn't point to meaningful content. mcr.microsoft.com/azure-sdk/azure-mcp is a docker image repository name, not a uri.

@jpsantoscosta
Copy link
Contributor Author

@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.

@JasonYeMSFT
Copy link
Member

/azp run mcp - pullrequest - live

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@jpsantoscosta
Copy link
Contributor Author

@JasonYeMSFT @alzimmermsft

The PR is approved and has passed all status checks. Can you please merge it when convenient? Thanks

@alzimmermsft alzimmermsft merged commit 4c7da1c into microsoft:main Jan 7, 2026
25 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in Azure MCP Server Jan 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants