update doc for unsecure option #323
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation for the --enable-insecure-transports command line option to provide clearer security warnings. The change makes it more explicit that this option enables unauthenticated HTTP transport and poses security risks.
Key Changes
- Enhanced XML documentation comment for the
EnableInsecureTransportsproperty - Updated command line option description to include specific security warnings
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| core/Azure.Mcp.Core/src/Areas/Server/Options/ServiceStartOptions.cs | Added detailed security warning to XML documentation for EnableInsecureTransports property |
| core/Azure.Mcp.Core/src/Areas/Server/Options/ServiceOptionDefinitions.cs | Updated command line option description with explicit security warnings |
Comments suppressed due to low confidence (1)
core/Azure.Mcp.Core/src/Areas/Server/Options/ServiceStartOptions.cs:1
- There's a duplicate word 'mode' in the documentation comment. It should be 'Gets or sets the mode for the server.'
// Copyright (c) Microsoft Corporation.
joshfree
approved these changes
Sep 4, 2025
jongio
approved these changes
Sep 4, 2025
jongio
reviewed
Sep 8, 2025
| $"--{EnableInsecureTransportsName}", | ||
| () => false, | ||
| "Enable insecure transport") | ||
| "Enables insecure, unauthenticated transport over streamable HTTP. Use with extreme caution, this disables all transport security and may expose sensitive data to interception.") |
There was a problem hiding this comment.
Description needs to be explicitly set
|
@anuchandy please follow up |
|
@anuchandy are you planning to merge this PR or should it be closed? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
What does this PR do?
[Provide a clear, concise description of the changes][Any additional context, screenshots, or information that helps reviewers]Adding additional text on the
--enable-insecure-transportswitch that indicates that connections to the streamable http transport are not authenticated, making it clear why it's marked as insecure.GitHub issue number?
[Link to the GitHub issue this PR addresses]Pre-merge Checklist
CHANGELOG.mdfor product changes (features, bug fixes, UI/UX, updated dependencies)README.mddocumentation/docs/azmcp-commands.md/docs/e2eTestPrompts.mdToolDescriptionEvaluatorand obtained a score of0.4or more and a top 3 ranking for all related test promptscrypto mining, spam, data exfiltration, etc.)/azp run mcp - pullrequest - liveto run Live Test Pipeline