Skip to content

Update contributing guide for HTTP mode#962

Merged
srnagar merged 1 commit intomicrosoft:feature/2.0beta-remotefrom
srnagar:http-docs
Oct 28, 2025
Merged

Update contributing guide for HTTP mode#962
srnagar merged 1 commit intomicrosoft:feature/2.0beta-remotefrom
srnagar:http-docs

Conversation

@srnagar
Copy link
Copy Markdown
Member

@srnagar srnagar commented Oct 27, 2025

This pull request adds detailed instructions for running the Azure MCP Server in HTTP mode and clarifies configuration steps for local development and testing. The documentation now covers both running the server via dotnet run and using the built executable, including necessary environment variables and configuration for Azure AD authentication. These improvements help streamline onboarding and troubleshooting for developers.

Documentation improvements for running and configuring Azure MCP Server:

  • Added step-by-step instructions for running the Azure MCP Server in HTTP mode, including options for using dotnet run (leveraging launchSettings.json) and running the built executable directly, with clear details on required environment variables and command line arguments.
  • Provided example mcp.json configuration for both stdio and HTTP modes, clarifying how to connect to the server and what values to update for each scenario.

Developer experience and troubleshooting enhancements:

  • Updated TROUBLESHOOTING.md with a recommended workflow for local development, highlighting the use of dotnet run and the automatic configuration provided by launchSettings.json for HTTP mode operation.

@github-project-automation github-project-automation Bot moved this from Untriaged to In Progress in Azure MCP Server Oct 27, 2025
@joshfree joshfree added this to the 2025-11 milestone Oct 27, 2025
@joshfree joshfree added the documentation Improvements or additions to documentation label Oct 27, 2025
@srnagar srnagar marked this pull request as ready for review October 28, 2025 16:21
@srnagar srnagar requested review from a team as code owners October 28, 2025 16:21
@srnagar srnagar requested review from JasonYeMSFT, JonathanCrd, KarishmaGhiya, chidozieononiwu, g2vinay, msalaman and vukelich and removed request for a team October 28, 2025 16:21
@srnagar srnagar merged commit 1931caf into microsoft:feature/2.0beta-remote Oct 28, 2025
5 of 23 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Azure MCP Server Oct 28, 2025
Copy link
Copy Markdown
Member

@vukelich vukelich left a comment

Choose a reason for hiding this comment

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

Suggestions

Comment thread servers/Azure.Mcp.Server/TROUBLESHOOTING.md
Comment thread servers/Azure.Mcp.Server/TROUBLESHOOTING.md
Comment thread servers/Azure.Mcp.Server/TROUBLESHOOTING.md
Comment thread servers/Azure.Mcp.Server/TROUBLESHOOTING.md
Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md
vukelich added a commit that referenced this pull request Nov 3, 2025
…servers (#1020)

* Add remote HTTP server mode with OAuth authentication and downstream token acquisition. (#910)

Add remote HTTP server mode with OAuth authentication and downstream token acquisition

- Add RunAsRemoteHttpService and OutgoingAuthStrategy options to enable MCP server to run as a remote HTTP service
- Introduce ITokenProvider abstraction for dependency injection of downstream authentication tokens and credentials
- Add support for On-Behalf-Of (OBO) token flow and hosting environment identity modes for outgoing authentication
- Implement OAuth Protected Resource Metadata endpoint at /.well-known/oauth-protected-resource with WWW-Authenticate challenge
- Add Visual Studio and dotnet run launch profile for debugging remote MCP server with Microsoft.Identity.Web configuration
- Modernize HTTP host creation using WebApplicationBuilder with authentication and authorization middleware

* Update contributing guide for HTTP mode (#962)

* Add support for ENABLE_REMOTE compilation constant to include remote functionality only in non-trimmed builds (#1008)

* Exclude Obo roots when building in trim mode given the AOT violations in Obo apis

* Use aot safe apis for incoming auth

* unblock template cli, fix CreateArmClientAsync_CreatesAndUsesCachedClient

* dotnet format

* Define ENABLE_REMOTE build property for untrimmed build

* Require non-null ITenantService parameter to BaseAzureService to ensure all derived types can make authenticated Azure calls always. Fixes product, live tests, and unit tests. (#1029)

Require non-null ITenantService parameter to BaseAzureService to ensure all derived types can make authenticated Azure calls always. Fixes product, live tests, and unit tests.

* Update contributing guide and troubleshooting guide to address PR comments (#1005)

* Update contributing guide and troubleshooting guide to address PR comments

* move launchSettings instructions to wiki

* minor update

* update doc

* address pr comments

* change endpoint placeholder

---------

Co-authored-by: Srikanta <51379715+srnagar@users.noreply.github.com>
Co-authored-by: Anu Thomas <anuamd@hotmail.com>
colbytimm pushed a commit to colbytimm/microsoft-mcp that referenced this pull request Dec 8, 2025
…servers (microsoft#1020)

* Add remote HTTP server mode with OAuth authentication and downstream token acquisition. (microsoft#910)

Add remote HTTP server mode with OAuth authentication and downstream token acquisition

- Add RunAsRemoteHttpService and OutgoingAuthStrategy options to enable MCP server to run as a remote HTTP service
- Introduce ITokenProvider abstraction for dependency injection of downstream authentication tokens and credentials
- Add support for On-Behalf-Of (OBO) token flow and hosting environment identity modes for outgoing authentication
- Implement OAuth Protected Resource Metadata endpoint at /.well-known/oauth-protected-resource with WWW-Authenticate challenge
- Add Visual Studio and dotnet run launch profile for debugging remote MCP server with Microsoft.Identity.Web configuration
- Modernize HTTP host creation using WebApplicationBuilder with authentication and authorization middleware

* Update contributing guide for HTTP mode (microsoft#962)

* Add support for ENABLE_REMOTE compilation constant to include remote functionality only in non-trimmed builds (microsoft#1008)

* Exclude Obo roots when building in trim mode given the AOT violations in Obo apis

* Use aot safe apis for incoming auth

* unblock template cli, fix CreateArmClientAsync_CreatesAndUsesCachedClient

* dotnet format

* Define ENABLE_REMOTE build property for untrimmed build

* Require non-null ITenantService parameter to BaseAzureService to ensure all derived types can make authenticated Azure calls always. Fixes product, live tests, and unit tests. (microsoft#1029)

Require non-null ITenantService parameter to BaseAzureService to ensure all derived types can make authenticated Azure calls always. Fixes product, live tests, and unit tests.

* Update contributing guide and troubleshooting guide to address PR comments (microsoft#1005)

* Update contributing guide and troubleshooting guide to address PR comments

* move launchSettings instructions to wiki

* minor update

* update doc

* address pr comments

* change endpoint placeholder

---------

Co-authored-by: Srikanta <51379715+srnagar@users.noreply.github.com>
Co-authored-by: Anu Thomas <anuamd@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation remote-mcp

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants