docs: sync server start command options with code#1894
Merged
Conversation
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>
Contributor
There was a problem hiding this comment.
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
--transportdocumentation to describe bothstdioandhttptransports. - Added missing
azmcp server startoptions (--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.
- 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>
chidozieononiwu
approved these changes
Mar 2, 2026
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>
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
Fixes documentation drift in
servers/Azure.Mcp.Server/docs/azmcp-commands.mdwhere the Server Start Command Options table was missing options that exist in code (ServiceOptionDefinitions.cs).Changes
Fixed
--transportdescription: Removed outdated claim thatstdiois the only supported transport. Now documents bothstdio(local CLI) andhttp(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-elicitationwarning 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.cscore/Microsoft.Mcp.Core/src/Areas/Server/Options/OutgoingAuthStrategy.cscore/Microsoft.Mcp.Core/src/Areas/Server/Options/TransportTypes.csCloses #231