docs: fix unsupported headers in JSON stdin OpenTelemetry example, clarify MCP_GATEWAY_PORT behavior - #8564
Merged
Merged
Conversation
…etry example and clarify MCP_GATEWAY_PORT usage
Copilot
AI
changed the title
[WIP] Fix unsupported headers field in JSON stdin example
docs: fix unsupported Jul 3, 2026
headers in JSON stdin OpenTelemetry example, clarify MCP_GATEWAY_PORT behavior
lpcox
marked this pull request as ready for review
July 3, 2026 12:43
Contributor
There was a problem hiding this comment.
Pull request overview
This PR corrects two documentation inaccuracies around OpenTelemetry JSON stdin configuration and how the gateway’s listen port is set, aiming to prevent validation errors and reduce user confusion when configuring/running awmg.
Changes:
- Clarifies that
gateway.opentelemetry.headersis not supported in JSON stdin and removes it from the JSON stdin example indocs/CONFIGURATION.md, pointing users toOTEL_EXPORTER_OTLP_HEADERSinstead. - Rewords the README’s
portfield description to better explain that--listencontrols the bind address and that wrapper scripts construct it from env vars.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates the port field documentation to clarify how the listen address is set. |
| docs/CONFIGURATION.md | Fixes the OpenTelemetry JSON stdin example and labels headers as TOML-only, adding guidance for JSON stdin users. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Low
| | `agent_id` / `agentId` | Agent/session identifier used for routing and optional auth matching | | ||
| | `api_key` / `apiKey` | Deprecated alias for `agent_id` / `agentId` (accepted with warnings) | | ||
| | `port` | Metadata only; validated (1–65535) but does not control the listen address. Use the `--listen` flag or `MCP_GATEWAY_PORT` env var (containerized) to set the actual listen port. | | ||
| | `port` | Metadata only; validated (1–65535) but does not control the listen address. Use the `--listen` flag to set the listen address; `MCP_GATEWAY_PORT` is used by `run.sh`/`run_containerized.sh` to build the `--listen` argument, not read directly by `awmg`. | |
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.
Two documentation inaccuracies that cause user-facing failures or confusion:
The JSON stdin
gateway.opentelemetryexample included aheadersfield that the schema explicitly rejects (additionalProperties: falseinopentelemetryConfig, noheadersfield inStdinOpenTelemetryConfig). Users following this example will get a validation error and a broken gateway startup.The README implied
awmgreadsMCP_GATEWAY_PORTto set its listen address — it doesn't. Onlyrun.sh/run_containerized.shuse it to construct the--listenflag.Changes
docs/CONFIGURATION.mdheadersas TOML only in the OpenTelemetry field table (consistent withsample_rate)"headers"from the JSON stdin example block:OTEL_EXPORTER_OTLP_HEADERSas the correct mechanismREADME.mdportfield description to accurately state thatMCP_GATEWAY_PORTis consumed by wrapper scripts, not byawmgdirectly;--listenis the right flag