Skip to content

Reconcile config/env docs with actual JSON stdin and launcher variable behavior#6830

Merged
lpcox merged 3 commits into
mainfrom
copilot/update-documentation-reconciliation-report
Jun 1, 2026
Merged

Reconcile config/env docs with actual JSON stdin and launcher variable behavior#6830
lpcox merged 3 commits into
mainfrom
copilot/update-documentation-reconciliation-report

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jun 1, 2026

Nightly docs reconciliation flagged contradictory and misleading documentation around payloadPathPrefix, launcher env vars, and DOCKER_API_VERSION. This PR aligns docs with current implementation to prevent misconfiguration in run.sh, run_containerized.sh, and JSON-stdin setups.

  • Configuration docs: remove payloadPathPrefix contradiction

    • Removed payloadPathPrefix from the TOML-only / CLI-only table in docs/CONFIGURATION.md.
    • Kept it documented in gateway fields and clarified JSON stdin key naming.
  • Environment variable docs: scope by launcher script

    • Updated docs/ENVIRONMENT_VARIABLES.md to split bind/routing variables by script:
      • run.sh: HOST, MODE
      • run_containerized.sh: MCP_GATEWAY_HOST, MCP_GATEWAY_MODE
    • This replaces the previous mixed-scope wording that implied shared usage.
  • Docker API version semantics

    • Revised DOCKER_API_VERSION description to clarify it is not read directly by awmg and applies to inherited docker CLI subprocess behavior in helper scripts.
### `run.sh` (non-containerized)
| Variable | Description | Default |
|----------|-------------|---------|
| `HOST`   | Bind address for the gateway in `run.sh`. | `0.0.0.0` |
| `MODE`   | Routing mode flag passed to `awmg` by `run.sh`. | `--routed` |

### `run_containerized.sh` (containerized)
| Variable | Description | Default |
|----------|-------------|---------|
| `MCP_GATEWAY_HOST` | Bind address for the gateway in `run_containerized.sh`. | `0.0.0.0` |
| `MCP_GATEWAY_MODE` | Routing mode flag passed to `awmg` by `run_containerized.sh`. | `--routed` |

Copilot AI linked an issue Jun 1, 2026 that may be closed by this pull request
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
Copilot finished work on behalf of lpcox June 1, 2026 03:50
Copilot AI requested a review from lpcox June 1, 2026 03:50
@lpcox lpcox marked this pull request as ready for review June 1, 2026 04:16
Copilot AI review requested due to automatic review settings June 1, 2026 04:16
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.sh vs run_containerized.sh) in docs/ENVIRONMENT_VARIABLES.md.
  • Clarified DOCKER_API_VERSION affects only inherited docker CLI subprocess behavior (not read by awmg directly).
  • Updated docs/CONFIGURATION.md to keep payloadPathPrefix documented 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

Comment thread docs/CONFIGURATION.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@lpcox lpcox merged commit 8071f6d into main Jun 1, 2026
3 checks passed
@lpcox lpcox deleted the copilot/update-documentation-reconciliation-report branch June 1, 2026 04:27
This was referenced Jun 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📚 Documentation Reconciliation Report - 2026-05-31

3 participants