docs: add CLI mode documentation to Azure MCP Server READMEs#2058
Open
diberry wants to merge 6 commits intomicrosoft:mainfrom
Open
docs: add CLI mode documentation to Azure MCP Server READMEs#2058diberry wants to merge 6 commits intomicrosoft:mainfrom
diberry wants to merge 6 commits intomicrosoft:mainfrom
Conversation
Add CLI mode section to Azure MCP Server README with usage examples, comparison table, and package manager commands. Update root README description to mention CLI capability. Add CLI examples to llms-install.md for AI agent consumption. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diberry
requested review from
JasonYeMSFT,
chidozieononiwu,
Copilot,
fanyang-mono,
hallipr,
jairmyree,
weshaggard and
xiangyan99
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates repository documentation to highlight that Azure MCP Server tools can be invoked directly as CLI commands (without running the MCP server), aimed at shell-based agents and automation/CI usage.
Changes:
- Added a “CLI Mode” section to the Azure MCP Server README with scenario guidance and command/package-manager examples.
- Added a “CLI Mode (Direct Commands)” section to
llms-install.mdwith install/run examples. - Updated the root README Azure MCP description to mention direct CLI usage via
azmcp.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| servers/Azure.Mcp.Server/README.md | Adds CLI Mode docs and examples for running commands directly / via package managers. |
| llms-install.md | Adds CLI Mode section with quick-start command examples for npx/dnx/uvx. |
| README.md | Updates the Azure MCP entry to mention direct CLI command capability. |
You can also share your feedback on Copilot code review. Take the survey.
servers/Azure.Mcp.Server/README.md
Outdated
Comment on lines
+849
to
+852
| azmcp storage account list --subscription <subscription-id> | ||
|
|
||
| # List Cosmos DB accounts | ||
| azmcp cosmos account list --subscription <subscription-id> |
servers/Azure.Mcp.Server/README.md
Outdated
| azmcp cosmos account list --subscription <subscription-id> | ||
|
|
||
| # List Key Vault secrets | ||
| azmcp keyvault secret list --subscription <subscription-id> --vault-name <vault-name> |
servers/Azure.Mcp.Server/README.md
Outdated
| azmcp keyvault secret list --subscription <subscription-id> --vault-name <vault-name> | ||
|
|
||
| # List virtual machines | ||
| azmcp compute vm list --subscription <subscription-id> |
servers/Azure.Mcp.Server/README.md
Outdated
Comment on lines
+871
to
+877
| npx -y @azure/mcp@latest storage account list --subscription <subscription-id> | ||
|
|
||
| # .NET (dnx) | ||
| dnx Azure.Mcp -- azmcp storage account list --subscription <subscription-id> | ||
|
|
||
| # Python (uvx) | ||
| uvx --from msmcp-azure azmcp storage account list --subscription <subscription-id> |
llms-install.md
Outdated
Comment on lines
+72
to
+80
| ```bash | ||
| # Via npx (Node.js) | ||
| npx -y @azure/mcp@latest storage account list --subscription <subscription-id> | ||
|
|
||
| # Via dnx (.NET) | ||
| dnx Azure.Mcp -- azmcp storage account list --subscription <subscription-id> | ||
|
|
||
| # Via uvx (Python) | ||
| uvx --from msmcp-azure azmcp storage account list --subscription <subscription-id> |
llms-install.md
Outdated
Comment on lines
+88
to
+89
| azmcp keyvault secret list --subscription <sub-id> --vault-name <name> | ||
| azmcp compute vm list --subscription <sub-id> |
Squad review caught that npx examples were missing the azmcp command after the package name. dnx and uvx examples were already correct. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Addresses all 6 Copilot review comments on PR microsoft#2058: - storage account list → storage account get (lists when --account omitted) - cosmos account list → cosmos list - keyvault secret list --vault-name → keyvault secret get --vault - compute vm list → compute vm get (lists when --vm-name omitted) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
Author
|
All CI checks passing (15/15). The Azure MCP Documentation Squad has reviewed this PR — command examples verified against @jongallant — squad signed off. Ready for your review. |
- IDE-embedded agents: MCP → Either (shell access via integrated terminal) - Split framework rows by MCP SDK availability - Add multi-tenant SaaS, Custom GPT, batch processing rows - Add Claude Code to terminal agents - Add azmcp --help for CLI discovery - Remove vague 'quick one-off queries' row - Add framing note: same binary, same command tree, same auth Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Replace 10-row agent pattern table with concise bullets: CLI (shell access, token-efficient), MCP (SDK, discovery, no shell), Either (IDE agents). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Existing repo patterns use dnx Azure.Mcp server start without --. Align CLI examples to match. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Member
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds CLI mode documentation across Azure MCP Server READMEs to highlight that every MCP tool is also available as a direct CLI command via \�zmcp.
Changes
\servers/Azure.Mcp.Server/README.md\
\README.md\ (root)
\llms-install.md\
Positioning