Skip to content

docs: refresh Azure MCP global option descriptions - #3385

Open
Donna Gan (bleakbelladonnals) wants to merge 1 commit into
microsoft:mainfrom
bleakbelladonnals:codex/docs-global-options-3224
Open

docs: refresh Azure MCP global option descriptions#3385
Donna Gan (bleakbelladonnals) wants to merge 1 commit into
microsoft:mainfrom
bleakbelladonnals:codex/docs-global-options-3224

Conversation

@bleakbelladonnals

Copy link
Copy Markdown

What does this PR do?

Refreshes the Azure MCP global options table so it matches the current shared option descriptions:

  • documents that --subscription accepts a GUID or display name and explains its fallback behavior
  • corrects the global tenant option from --tenant-id to --tenant
  • synchronizes the retry count, initial delay, and retry mode descriptions with RetryPolicyOptions

This is a documentation-only change; it does not change command behavior or tool metadata.

GitHub issue number?

Fixes #3224

Validation

  • git diff --check
  • npx --yes cspell@^10.0.0 lint --config .vscode/cspell.json servers/Azure.Mcp.Server/docs/azmcp-commands.md

The PowerShell metadata script was not run because no generated tool metadata or tool implementation changed.

Pre-merge checklist

  • Read the contribution guidelines
  • PR title clearly describes the change
  • Commit history is clean with a single descriptive commit
  • Reviewed the source option descriptions for accuracy
  • Spelling check passes
  • Tests are not applicable to this documentation-only change
  • A changelog entry is not required for this documentation-only correction

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).
There may be pipelines that require an authorized user to comment /azp run to run.

@github-actions

Copy link
Copy Markdown
Contributor

Thank you for your contribution Donna Gan (@bleakbelladonnals)! We will review the pull request and get back to you soon.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the Azure MCP CLI documentation to bring the Global Options table in azmcp-commands.md back in sync with the shared option descriptions used across Azure MCP commands.

Changes:

  • Refreshes --subscription and --tenant descriptions to match the current shared option wording and option name.
  • Synchronizes retry option descriptions for --retry-max-retries, --retry-delay, and --retry-mode with RetryPolicyOptions.
Suppressed comments (2)

servers/Azure.Mcp.Server/docs/azmcp-commands.md:17

  • The --retry-max-delay description here doesn't match the shared retry option description (RetryPolicyOptions uses "Maximum delay in seconds, regardless of the retry strategy."). Since this PR aims to synchronize the global options table with the shared descriptions, this row should be updated too.
| `--retry-max-delay` | No | 10 | Maximum delay between retries (seconds) |

servers/Azure.Mcp.Server/docs/azmcp-commands.md:19

  • The --retry-network-timeout row is close, but the shared option description is "Network operation timeout in seconds." Aligning the wording keeps this table consistent with the source descriptions.
| `--retry-network-timeout` | No | 100 | Network operation timeout (seconds) |

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

|-----------|----------|---------|-------------|
| `--subscription` | No | Environment variable `AZURE_SUBSCRIPTION_ID` | Azure subscription ID for target resources |
| `--tenant-id` | No | - | Azure tenant ID for authentication |
| `--subscription` | No | Environment variable `AZURE_SUBSCRIPTION_ID` | The Azure subscription GUID identifier or display name. If not specified, the Azure CLI profile default subscription or `AZURE_SUBSCRIPTION_ID` environment variable will be used. |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc Gap] Global options table in azmcp-commands.md has stale descriptions after common parameter description refresh

2 participants