docs: fix three documentation inaccuracies (port field, MCP methods, tracing var expansion)#7157
Merged
Merged
Conversation
- README.md: Correct `port` field description to clarify it is metadata-only
and does not control the listen address; direct users to --listen flag or
MCP_GATEWAY_PORT env var instead.
- README.md: Replace ambiguous "forwarded as-is" MCP methods description with
accurate language distinguishing proxied methods from SDK-native lifecycle
methods.
- docs/CONFIGURATION.md: Remove incorrect claim that [gateway.tracing] supports
${VAR} expansion; only [gateway.opentelemetry] fields are expanded.
Copilot
AI
changed the title
[WIP] Fix discrepancies in documentation reconciliation report
docs: fix three documentation inaccuracies (port field, MCP methods, tracing var expansion)
Jun 7, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates user-facing documentation to correct three misleading claims called out by the nightly reconciliation report, aligning docs with current gateway behavior/config parsing.
Changes:
- Clarify that the
gateway.portfield is metadata-only (range-validated) and does not control the actual bind/listen address. - Correct the description of which MCP methods are proxied vs handled by the MCP SDK session/lifecycle handling.
- Fix TOML variable-expansion documentation to match implementation:
${VAR_NAME}expansion applies only to[gateway.opentelemetry], not legacy[gateway.tracing].
Show a summary per file
| File | Description |
|---|---|
| README.md | Corrects port semantics and clarifies which MCP methods are proxied vs handled by the SDK. |
| docs/CONFIGURATION.md | Fixes TOML variable-expansion claims to match the actual tracing/opentelemetry expansion path. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 0
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.
Three misleading or incorrect documentation claims identified by the nightly reconciliation report.
Changes
README.md—portfield: Was"Listen port", implying it sets the server's bind address. The field is metadata-only (range-validated, never read by the server). Updated to direct users to--listen/MCP_GATEWAY_PORTfor actual listen address control.README.md— MCP methods:"forwarded as-is"implied arbitrary MCP methods are proxied to backends. Onlytools/listandtools/callare proxied; all other methods are handled natively by the MCP SDK. Reworded accordingly.docs/CONFIGURATION.md(line 413): Incorrectly listed[gateway.tracing]alongside[gateway.opentelemetry]as supporting${VAR_NAME}expansion.expandTracingVariables()is only called whencfg.Gateway.Opentelemetry != nil; the legacytracingblock is never expanded. Corrected to matchconfig.example.tomlandCONTRIBUTING.md, which already had the right description.