Skip to content

Document TLS Termination#2127

Open
anuchandy wants to merge 1 commit intomicrosoft:mainfrom
anuchandy:http-doc
Open

Document TLS Termination#2127
anuchandy wants to merge 1 commit intomicrosoft:mainfrom
anuchandy:http-doc

Conversation

@anuchandy
Copy link
Member

@anuchandy anuchandy commented Mar 20, 2026

What does this PR do?

[Provide a clear, concise description of the changes]

Users unfamiliar with platform-managed TLS were confused by the server listening on HTTP, interpreting it as a missing feature or misconfiguration rather than an intentional design. This section clarifies the architecture, explains how TLS is handled across Azure hosting platforms, and covers the responsibilities of users self-hosting outside Azure.

[Add additional context, screenshots, or information that helps reviewers]

GitHub issue number?

[Link to the GitHub issue this PR addresses]

Pre-merge Checklist

  • Required for All PRs
    • Read contribution guidelines
    • PR title clearly describes the change
    • Commit history is clean with descriptive messages (cleanup guide)
    • Added comprehensive tests for new/modified functionality
    • Created a changelog entry if the change falls among the following: new feature, bug fix, UI/UX update, breaking change, or updated dependencies. Follow the changelog entry guide
  • For MCP tool changes:
    • One tool per PR: This PR adds or modifies only one MCP tool for faster review cycles
    • Updated servers/Azure.Mcp.Server/README.md and/or servers/Fabric.Mcp.Server/README.md documentation
    • Validate README.md changes running the script ./eng/scripts/Process-PackageReadMe.ps1. See Package README
    • For new or modified tool descriptions, ran ToolDescriptionEvaluator and obtained a score of 0.4 or more and a top 3 ranking for all related test prompts
    • For tools with new names, including new tools or renamed tools, update consolidated-tools.json
    • For renamed tools, follow the Tool Rename Checklist and tag the PR with the breaking-change label
    • For new tools associated with Azure services or publicly available tools/APIs/products, add URL to documentation in the PR description
  • Extra steps for Azure MCP Server tool changes:
    • Updated command list in servers/Azure.Mcp.Server/docs/azmcp-commands.md
    • Ran ./eng/scripts/Update-AzCommandsMetadata.ps1 to update tool metadata in azmcp-commands.md (required for CI)
    • Updated test prompts in servers/Azure.Mcp.Server/docs/e2eTestPrompts.md
    • 👉 For Community (non-Microsoft team member) PRs:
      • Security review: Reviewed code for security vulnerabilities, malicious code, or suspicious activities before running tests (crypto mining, spam, data exfiltration, etc.)
      • Manual tests run: added comment /azp run mcp - pullrequest - live to run Live Test Pipeline

Copy link
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

This PR updates the Azure MCP Server troubleshooting documentation to explain how TLS/HTTPS is expected to be handled when hosting the server (particularly in Azure hosting environments).

Changes:

  • Added a new “TLS Termination” section describing the intended HTTPS/TLS termination model across common Azure hosting options.
  • Added guidance for self-hosting scenarios where a TLS-terminating reverse proxy (or direct Kestrel HTTPS) is required.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Untriaged

Development

Successfully merging this pull request may close these issues.

3 participants