diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md index 834525c7..a8f35252 100644 --- a/docs/CONFIGURATION.md +++ b/docs/CONFIGURATION.md @@ -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) | @@ -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` | diff --git a/docs/ENVIRONMENT_VARIABLES.md b/docs/ENVIRONMENT_VARIABLES.md index d4904eeb..16f4da8d 100644 --- a/docs/ENVIRONMENT_VARIABLES.md +++ b/docs/ENVIRONMENT_VARIABLES.md @@ -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 @@ -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