Skip to content

docs: sync server start command options with code#1894

Merged
jongio merged 2 commits intomainfrom
docs/231-documentation-sync-server-start
Mar 2, 2026
Merged

docs: sync server start command options with code#1894
jongio merged 2 commits intomainfrom
docs/231-documentation-sync-server-start

Conversation

@jongio
Copy link
Copy Markdown
Contributor

@jongio jongio commented Feb 28, 2026

Summary

Fixes documentation drift in servers/Azure.Mcp.Server/docs/azmcp-commands.md where the Server Start Command Options table was missing options that exist in code (ServiceOptionDefinitions.cs).

Changes

Fixed

  • --transport description: Removed outdated claim that stdio is the only supported transport. Now documents both stdio (local CLI) and http (Docker/remote scenarios).

Added missing options to the Server Start Command Options table

  • --outgoing-auth-strategy: Documents all 3 valid values (NotSet, UseHostingEnvironmentIdentity, UseOnBehalfOf) with explanation of each strategy.
  • --dangerously-write-support-logs-to-dir: Documents the support logging option with security warning (mirrors existing --dangerously-disable-elicitation warning style).
  • --cloud: Documents sovereign cloud support (AzureCloud, AzureChinaCloud, AzureUSGovernment, custom URL) with example usage.

Verification

All option names, defaults, descriptions, and valid values verified against source code in:

  • core/Microsoft.Mcp.Core/src/Areas/Server/Options/ServiceOptionDefinitions.cs
  • core/Microsoft.Mcp.Core/src/Areas/Server/Options/OutgoingAuthStrategy.cs
  • core/Microsoft.Mcp.Core/src/Areas/Server/Options/TransportTypes.cs

Closes #231

Add missing --outgoing-auth-strategy, --dangerously-write-support-logs-to-dir,
and --cloud options to the Server Start Command Options table in
azmcp-commands.md. Fix --transport description to document both stdio and http
transport values.

Refs #231

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
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

Updates Azure MCP Server command documentation to remove drift from the current azmcp server start option set and behavior as implemented in ServiceOptionDefinitions.

Changes:

  • Updated --transport documentation to describe both stdio and http transports.
  • Added missing azmcp server start options (--outgoing-auth-strategy, --dangerously-write-support-logs-to-dir, --cloud) to the options table.
  • Added security-warning and usage guidance sections for newly documented “dangerous” options and auth/cloud behavior.

Comment thread servers/Azure.Mcp.Server/docs/azmcp-commands.md Outdated
Comment thread servers/Azure.Mcp.Server/docs/azmcp-commands.md Outdated
Comment thread servers/Azure.Mcp.Server/docs/azmcp-commands.md Outdated
Comment thread servers/Azure.Mcp.Server/docs/azmcp-commands.md Outdated
- Fix typo: 'exiting' → 'existing' for --namespace description
- Clarify --transport http is only available in Docker/HTTP-enabled builds
- Clarify --cloud custom URL only changes auth authority, not ARM endpoints
- Clarify UseOnBehalfOf requires authenticated HTTP (not just HTTP transport)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-project-automation github-project-automation Bot moved this from Untriaged to In Progress in Azure MCP Server Mar 2, 2026
@jongio jongio merged commit d43c4f7 into main Mar 2, 2026
15 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Azure MCP Server Mar 2, 2026
@jongio jongio deleted the docs/231-documentation-sync-server-start branch March 2, 2026 19:37
colbytimm pushed a commit to colbytimm/microsoft-mcp that referenced this pull request Apr 20, 2026
* docs: sync server start options with code

Add missing --outgoing-auth-strategy, --dangerously-write-support-logs-to-dir,
and --cloud options to the Server Start Command Options table in
azmcp-commands.md. Fix --transport description to document both stdio and http
transport values.

Refs microsoft#231

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: address review feedback on server start options

- Fix typo: 'exiting' → 'existing' for --namespace description
- Clarify --transport http is only available in Docker/HTTP-enabled builds
- Clarify --cloud custom URL only changes auth authority, not ARM endpoints
- Clarify UseOnBehalfOf requires authenticated HTTP (not just HTTP transport)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Documentation is out of sync from code

3 participants