Skip to content

docs: fix unsupported headers in JSON stdin OpenTelemetry example, clarify MCP_GATEWAY_PORT behavior #8564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lpcox merged 2 commits into from
Jul 3, 2026
Merged

docs: fix unsupported headers in JSON stdin OpenTelemetry example, clarify MCP_GATEWAY_PORT behavior #8564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
164830a
Initial plan
Copilot Jul 3, 2026
e022f58
fix(docs): remove unsupported headers field from JSON stdin opentelem…
Copilot Jul 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ Key configuration fields (gateway-level under `[gateway]` in TOML / `"gateway"`
|-------|-------------|
| `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`. |
| `payload_dir` / `payloadDir` | Directory for large payload storage (must be absolute path) |
| `payload_size_threshold` / `payloadSizeThreshold` | Size threshold in bytes for payload storage (default: `524288`) |
| `trusted_bots` / `trustedBots` | Additional bot usernames to treat as trusted with "approved" integrity. Additive to the built-in trusted bot list. Non-empty array when present. Example: `["my-bot[bot]"]` |
Expand Down
7 changes: 4 additions & 3 deletions docs/CONFIGURATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,7 +445,7 @@ The gateway supports OpenTelemetry tracing via a nested configuration block. For
| Field | Description | Default |
|-------|-------------|---------|
| `endpoint` | OTLP/HTTP collector URL. With the `opentelemetry` key, this field is required, must be non-empty, and MUST use `https://` (spec §4.1.3.6). With legacy `tracing`, an empty value disables tracing (noop tracer, zero overhead), and `http://` endpoints may be used. | (disabled) |
| `headers` | Comma-separated `key=value` HTTP headers for export requests. Supports `${VAR}` expansion. Example: `"Authorization=Bearer ${OTEL_TOKEN}"` | (none) |
| `headers` (TOML only) | Comma-separated `key=value` HTTP headers for export requests. Supports `${VAR}` expansion. Example: `"Authorization=Bearer ${OTEL_TOKEN}"` | (none) |
| `traceId` (JSON) / `trace_id` (TOML) | Parent trace ID (32-char lowercase hex, W3C format) to link gateway spans into a pre-existing trace. Supports `${VAR}` expansion. | (none) |
| `spanId` (JSON) / `span_id` (TOML) | Parent span ID (16-char lowercase hex, W3C format). Ignored without `traceId`. Supports `${VAR}` expansion. | (none) |
| `serviceName` (JSON) / `service_name` (TOML) | The `service.name` resource attribute reported in traces. | `mcp-gateway` |
Expand All @@ -471,13 +471,14 @@ headers = "Authorization=Bearer ${OTEL_TOKEN}"
"endpoint": "https://otel-collector.example.com",
"serviceName": "mcp-gateway",
"traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
"spanId": "00f067aa0ba902b7",
"headers": "Authorization=Bearer ${OTEL_TOKEN}"
"spanId": "00f067aa0ba902b7"
}
}
}
```

> **Note:** The `headers` field is **not supported** in JSON stdin `gateway.opentelemetry` (per spec §4.1.3.6). To pass OTLP export headers when using JSON stdin config, use the `OTEL_EXPORTER_OTLP_HEADERS` environment variable.

**TOML-only / CLI-only options** (not available in JSON stdin):

| Option | CLI Flag | Env Var | Default |
Expand Down
Loading