Skip to content

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

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 3 commits into from
Jun 1, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bbb4a57
Initial plan
Copilot Jun 1, 2026
356b726
Fix docs mismatches for config and env vars
Copilot Jun 1, 2026
5cff141
Potential fix for pull request finding
lpcox Jun 1, 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
3 changes: 1 addition & 2 deletions docs/CONFIGURATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ The `customSchemas` top-level field allows you to define custom server types bey
| `startupTimeout` | Seconds to wait for backend startup | `30` |
| `toolTimeout` | Maximum seconds for a single tool call, enforced as a context deadline on all backend requests (stdio and HTTP) | `60` |
| `payloadDir` | Directory for large payload files. Must be an absolute path. | `/tmp/jq-payloads` |
| `payloadPathPrefix` | Optional path prefix used when returning `payloadPath` values to clients (for example when the host payload directory is mounted at a different in-container path) | (empty - use actual filesystem path) |
| `payloadPathPrefix` (JSON stdin) / `payload_path_prefix` (TOML) | Optional path prefix used when returning `payloadPath` values to clients (for example when the host payload directory is mounted at a different in-container path) | (empty - use actual filesystem path) |
| `payloadSizeThreshold` (JSON) / `payload_size_threshold` (TOML) | Size threshold in bytes; responses larger than this are stored to disk and returned as a `payloadPath` reference | `524288` (512 KB) |
| `trustedBots` (JSON) / `trusted_bots` (TOML) | Optional list of additional bot usernames to trust with "approved" integrity level. Additive to the built-in trusted bot list. When specified, must be a non-empty array with non-empty string entries (spec §4.1.3.4); omit the field entirely if not needed. Example: `["my-bot[bot]", "org-automation"]` | (disabled) |
| `keepaliveInterval` (JSON) / `keepalive_interval` (TOML) | Interval (seconds) between keepalive pings sent to HTTP backends. Prevents remote servers from expiring idle sessions. Set to `-1` to disable keepalive pings entirely. | `1500` (25 min) |
Expand Down Expand Up @@ -451,7 +451,6 @@ headers = "Authorization=Bearer ${OTEL_TOKEN}"

| Option | CLI Flag | Env Var | Default |
|--------|----------|---------|---------|
| Payload path prefix | `--payload-path-prefix` | `MCP_GATEWAY_PAYLOAD_PATH_PREFIX` | (empty) |
| Sequential launch | `--sequential-launch` | — | `false` |
| Guards mode | `--guards-mode` | `MCP_GATEWAY_GUARDS_MODE` | `strict` |

Expand Down
17 changes: 13 additions & 4 deletions docs/ENVIRONMENT_VARIABLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,21 @@ These variables are intended for local testing and development only:

## Containerized Deployment Variables

When using `run_containerized.sh` or `run.sh`, these variables control the bind address and routing mode:
These variables are script-specific controls for bind address and routing mode:

### `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` (e.g., `--routed`, `--unified`). | `--routed` |

### `run_containerized.sh` (containerized)

| Variable | Description | Default |
|----------|-------------|---------|
| `MCP_GATEWAY_HOST` | Bind address for the gateway. Read by both `run.sh` and `run_containerized.sh`. | `0.0.0.0` |
| `MCP_GATEWAY_MODE` | Routing mode flag passed to `awmg` (e.g., `--routed`, `--unified`). Read by both `run.sh` and `run_containerized.sh`. | `--routed` |
| `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` (e.g., `--routed`, `--unified`). | `--routed` |

## Docker Configuration

Expand All @@ -70,7 +79,7 @@ When using `run_containerized.sh` or `run.sh`, these variables control the bind

| Variable | Description | Default |
|----------|-------------|---------|
| `DOCKER_API_VERSION` | Docker API version used by helper scripts such as `run.sh`, integration test scripts, and `run_containerized.sh`. The Docker Go client in `awmg` auto-negotiates API version, but an exported `DOCKER_API_VERSION` can still affect `docker` CLI subprocesses launched with the inherited environment. | Set by querying Docker daemon's current API version; falls back to `1.44` if detection fails |
| `DOCKER_API_VERSION` | Docker API version used by helper scripts such as `run.sh`, integration test scripts, and `run_containerized.sh`. Not read directly by `awmg`; it only affects `docker` CLI subprocesses launched with the inherited environment. | Set by querying Docker daemon's current API version; falls back to `1.44` if detection fails |

## GitHub Authentication

Expand Down