Reconcile config/env docs with actual JSON stdin and launcher variable behavior#6830
Merged
Merged
Conversation
Copilot
AI
changed the title
[WIP] Fix discrepancies in documentation reconciliation report
Reconcile config/env docs with actual JSON stdin and launcher variable behavior
Jun 1, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns configuration and environment-variable documentation with the gateway’s actual JSON-stdin and launcher-script behaviors to prevent misconfiguration when running via run.sh, run_containerized.sh, or piping JSON config.
Changes:
- Split bind/routing environment variables by launcher script (
run.shvsrun_containerized.sh) indocs/ENVIRONMENT_VARIABLES.md. - Clarified
DOCKER_API_VERSIONaffects only inheriteddockerCLI subprocess behavior (not read byawmgdirectly). - Updated
docs/CONFIGURATION.mdto keeppayloadPathPrefixdocumented under gateway fields and removed it from the “TOML-only / CLI-only” table.
Show a summary per file
| File | Description |
|---|---|
| docs/ENVIRONMENT_VARIABLES.md | Separates script-scoped variables and clarifies Docker API version semantics for helper scripts. |
| docs/CONFIGURATION.md | Adjusts payloadPathPrefix documentation and removes it from the “TOML-only / CLI-only” options table. |
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: 1
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This was referenced Jun 1, 2026
Closed
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.
Nightly docs reconciliation flagged contradictory and misleading documentation around
payloadPathPrefix, launcher env vars, andDOCKER_API_VERSION. This PR aligns docs with current implementation to prevent misconfiguration inrun.sh,run_containerized.sh, and JSON-stdin setups.Configuration docs: remove
payloadPathPrefixcontradictionpayloadPathPrefixfrom the TOML-only / CLI-only table indocs/CONFIGURATION.md.Environment variable docs: scope by launcher script
docs/ENVIRONMENT_VARIABLES.mdto split bind/routing variables by script:run.sh:HOST,MODErun_containerized.sh:MCP_GATEWAY_HOST,MCP_GATEWAY_MODEDocker API version semantics
DOCKER_API_VERSIONdescription to clarify it is not read directly byawmgand applies to inheriteddockerCLI subprocess behavior in helper scripts.