Update docs for remote mcp server #1044
Open
Conversation
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
g2vinay
requested review from
chidozieononiwu,
hallipr,
msalaman,
tmeschter,
vukelich,
weshaggard and
xiangyan99
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for Remote MCP Server considerations, covering authentication strategies, command implementation patterns, and deployment guidance for HTTP transport mode. The changes emphasize writing transport-agnostic code that works identically in both stdio (local) and HTTP (remote) modes.
- Adds detailed Remote MCP Server implementation guidance in
new-command.md - Expands troubleshooting documentation with HTTP mode testing and common authentication issues
- Updates contributor guidelines and agent instructions with remote mode best practices
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| servers/Azure.Mcp.Server/docs/new-command.md | Adds extensive "Remote MCP Server Considerations" section covering OBO vs Hosting Environment Identity, transport-agnostic design patterns, thread safety, and testing requirements |
| servers/Azure.Mcp.Server/TROUBLESHOOTING.md | Adds local testing instructions for HTTP mode and common authentication/authorization troubleshooting scenarios (401, 403, OBO failures) |
| CONTRIBUTING.md | Adds tip for testing Remote HTTP mode locally during development |
| AGENTS.md | Adds remote mode guidelines to Do/Don't lists and includes architecture comparison table with key differences between stdio and HTTP modes |
srnagar
reviewed
Nov 5, 2025
JasonYeMSFT
reviewed
Nov 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Updates docs for remote MCP.