Skip to content

Commit dfac8a5

Browse files
authored
Fix incorrect default values in docs and example config for startup/tool timeouts and domain (#3652)
Three documentation discrepancies between `config_core.go` constants and user-facing docs: `startupTimeout`/`toolTimeout` defaults were documented as 2× their actual values, and `domain` was documented as defaulting to `"localhost"` when it has no code-level default. ## Changes - **`docs/CONFIGURATION.md`** — Gateway config table: `startupTimeout` `60`→`30`, `toolTimeout` `120`→`60`, `domain` default `localhost`→`(unset)` - **`config.example.toml`** — Inline comments corrected: `(default: 60)`→`(default: 30)` and `(default: 120)`→`(default: 60)`; explicit override values (`60`/`120`) intentionally kept as examples of non-default configuration ## Authoritative source ```go // internal/config/config_core.go DefaultStartupTimeout = 30 // seconds (per spec §4.1.3) DefaultToolTimeout = 60 // seconds (per spec §4.1.3) ```
2 parents ab5d495 + d98e813 commit dfac8a5

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

config.example.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ api_key = ""
2222
# Used for CORS and other domain-specific features
2323
domain = ""
2424

25-
# Timeout for backend MCP server startup in seconds (default: 60)
25+
# Timeout for backend MCP server startup in seconds (default: 30)
2626
# How long to wait for an MCP server to start before timing out
2727
startup_timeout = 60
2828

29-
# Timeout for tool execution in seconds (default: 120)
29+
# Timeout for tool execution in seconds (default: 60)
3030
# How long to wait for a tool call to complete before timing out
3131
tool_timeout = 120
3232

docs/CONFIGURATION.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -364,9 +364,9 @@ The `customSchemas` top-level field allows you to define custom server types bey
364364
|-------|-------------|---------|
365365
| `port` | Validated and stored for metadata purposes only. The actual listen address is always set by the `--listen` CLI flag (default `127.0.0.1:3000`). | `3000` (informational only) |
366366
| `apiKey` | API key for authentication | (disabled) |
367-
| `domain` | Gateway domain (`"localhost"`, `"host.docker.internal"`, or `"${VAR}"`) | `localhost` |
368-
| `startupTimeout` | Seconds to wait for backend startup | `60` |
369-
| `toolTimeout` | Seconds to wait for tool execution | `120` |
367+
| `domain` | Gateway domain (`"localhost"`, `"host.docker.internal"`, or `"${VAR}"`) | (unset) |
368+
| `startupTimeout` | Seconds to wait for backend startup | `30` |
369+
| `toolTimeout` | Seconds to wait for tool execution | `60` |
370370
| `payloadDir` | Directory for large payload files | `/tmp/jq-payloads` |
371371
| `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) |
372372
| `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) |

0 commit comments

Comments
 (0)