docs: fix 6 documentation discrepancies from nightly reconciliation report#10062
Conversation
- README.md: clarify `--otlp-sample-rate` has no env-var fallback (#1) - README.md: state CLI enforces --config or --config-stdin via MarkFlagsOneRequired (#3) - README.md: improve schema-required fields phrasing to be more precise (#4) - CONTRIBUTING.md: change 'Go 1.26.4 or later' to 'Go 1.26.4' (#5) - CONTRIBUTING.md: qualify container port-mapping validation as conditional (#2) - CONTRIBUTING.md: update JSON stdin example to include required gateway fields (#6) Closes #10028
There was a problem hiding this comment.
Pull request overview
Aligns operator and contributor documentation with current configuration and startup behavior.
Changes:
- Clarifies required configuration fields and CLI flags.
- Updates tracing, Go version, and container-validation guidance.
- Adds a valid JSON stdin example.
Show a summary per file
| File | Description |
|---|---|
| README.md | Clarifies schema, CLI, and tracing configuration behavior. |
| CONTRIBUTING.md | Updates prerequisites, examples, and container validation details. |
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: Medium
| | `OTEL_SERVICE_NAME` | Service name reported in traces (default: `mcp-gateway`) | | ||
|
|
||
| Use `--otlp-sample-rate <float>` to control trace sampling (range `0.0`–`1.0`, default `1.0`). | ||
| Use `--otlp-sample-rate <float>` to control trace sampling (range `0.0`–`1.0`, default `1.0`). Note: unlike `--otlp-endpoint` and `--otlp-service-name`, `--otlp-sample-rate` has no environment-variable fallback and can only be set via this flag or the `gateway.tracing.sampleRate` config field. |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
@copilot address review feedback |
🔒 mcpg Read-Only Stress — default AWFSurface coverage: MCP tool calls + proxied CLI (REST) + GraphQL mutations
Overall: PASS Notes:
References: §30162477604
|
🔒 mcpg Read-Only Stress — gVisorSurface coverage: MCP tool calls + proxied CLI (REST) + GraphQL mutations
Overall: PASS
|
🔒 mcpg Read-Only Stress — docker-sbxSurface coverage: MCP tool calls + proxied CLI (REST) + GraphQL mutations
Overall: PASS References: §30162477575
|
Six doc/code mismatches identified by the nightly reconciliation workflow — operators could misconfigure or misread guarantees based on the existing text.
README.md
--otlp-sample-ratehas no env-var fallback — unlike--otlp-endpoint(OTEL_EXPORTER_OTLP_ENDPOINT) and--otlp-service-name(OTEL_SERVICE_NAME),--otlp-sample-rateis CLI/config-only; clarified inline so operators don't expectMCP_GATEWAY_OTLP_SAMPLE_RATEto work.--config-stdinis enforced, not advisory — Cobra'sMarkFlagsOneRequired("config", "config-stdin")makes this a hard requirement; updated note to say "The CLI requires either--configor--config-stdin".gatewayobject structure (port,domain, and one ofagentId/apiKey).CONTRIBUTING.md
Go version — "Go 1.26.4 or later" → "Go 1.26.4"; only 1.26.4 is tested/pinned in
go.modand the Makefile.Container startup validation overstated — port-mapping check is conditional: skipped when container ID cannot be resolved or host networking is in use. Updated the bullet to reflect actual
validate_port_mapping()behavior.JSON stdin example omits required gateway fields — the placeholder
{"mcpServers": {...}}would fail schema validation immediately. Replaced with a minimal valid example: