docs/configuration/config-file.md
MCPProxy uses a JSON configuration file located at ~/.mcpproxy/mcp_config.json.
| Platform | Default Location |
|---|---|
| macOS | ~/.mcpproxy/mcp_config.json |
| Linux | ~/.mcpproxy/mcp_config.json |
| Windows | %USERPROFILE%\.mcpproxy\mcp_config.json |
{
"listen": "127.0.0.1:8080",
"data_dir": "~/.mcpproxy",
"api_key": "your-secret-api-key",
"enable_socket": true,
"health_check_interval": "30s",
"tool_discovery_interval": "5m",
"tools_limit": 15,
"tool_response_limit": 20000,
"enable_code_execution": false,
"code_execution_timeout_ms": 120000,
"code_execution_max_tool_calls": 0,
"code_execution_pool_size": 10,
"features": {
"enable_web_ui": true
},
"update_check": {
"enabled": true,
"channel": "stable"
},
"mcpServers": []
}
| Option | Type | Default | Description |
|---|---|---|---|
listen | string | 127.0.0.1:8080 | Address and port to listen on |
data_dir | string | ~/.mcpproxy | Directory for data storage |
api_key | string | auto-generated | API key for REST API authentication |
trusted_hosts | string[] | [] | Non-loopback Host header values accepted on a loopback listener. Needed when running behind a reverse proxy — see Reverse Proxy Deployment |
require_mcp_auth | boolean | false | Require an API key on the /mcp endpoint (off by default for client compatibility). Enable when exposing MCPProxy beyond localhost |
enable_socket | boolean | true | Enable Unix socket/named pipe for local communication |
| Option | Type | Default | Description |
|---|---|---|---|
features.enable_web_ui | boolean | true | Enable the web management interface |
| Option | Type | Default | Description |
|---|---|---|---|
tools_limit | integer | 15 | Maximum tools to return in a single request |
tool_response_limit | integer | 20000 | Maximum characters in tool response |
MCPProxy keeps upstream connections fresh with two independent background loops:
ping to confirm the connection is alive, andnotifications/tools/list_changed; the sweep is a fallback for servers that don't advertise listChanged.)Both cadences are configurable globally, and can be overridden per server (see Upstream Servers). Values are duration strings such as 30s, 5m, or 1h.
| Option | Type | Default | Description |
|---|---|---|---|
health_check_interval | duration | 30s | Cadence of the lightweight liveness ping. Accepts 0s or 5s–1h. 0s disables the probe. |
tool_discovery_interval | duration | 5m | Cadence of the periodic tools/list re-index sweep. Accepts 0s or 30s–24h. 0s disables the sweep. |
Resolution order: per-server value → global value → built-in default. Leaving a key unset preserves the previous behaviour, so existing configs are unaffected by an upgrade.
{
"health_check_interval": "30s",
"tool_discovery_interval": "5m",
"mcpServers": [
{
"name": "chatty-server",
"health_check_interval": "2m",
"tool_discovery_interval": "0s"
}
]
}
Notes:
0s = disabled. Disabling the discovery sweep for a server that does not support listChanged means tool changes are only picked up on (re)connect — fine for static servers, worth knowing for dynamic ones. With the liveness probe disabled, a dead transport is detected lazily (on the next real tool call or discovery sweep) rather than proactively.health_check_interval is a no-op — their liveness is monitored at the container level, not via MCP ping. tool_discovery_interval still applies. Remote (HTTP/SSE) servers benefit most from the ping-based probe.| Option | Type | Default | Description |
|---|---|---|---|
enable_code_execution | boolean | false | Enable JavaScript code execution tool |
code_execution_timeout_ms | integer | 120000 | Execution timeout in milliseconds |
code_execution_max_tool_calls | integer | 0 | Maximum tool calls (0 = unlimited) |
code_execution_pool_size | integer | 10 | VM pool size for code execution |
Controls the background upgrade-awareness checker. Both keys are optional and hot-reloadable (no restart needed).
| Option | Type | Default | Description |
|---|---|---|---|
update_check.enabled | boolean | true | Master switch. When false, no network check runs (background poll and manual re-check) and no upgrade nudge appears on any surface — the update object is omitted from /api/v1/info. |
update_check.channel | string | "stable" | Release channel: "stable" (prereleases never offered) or "rc" (prerelease tags like v0.47.0-rc.1 included). |
The existing environment switches keep working and win over these keys:
MCPPROXY_DISABLE_AUTO_UPDATE=true force-disables checking, and
MCPPROXY_ALLOW_PRERELEASE_UPDATES=true force-selects the prerelease channel.
They only widen in one direction — they cannot re-enable checking that the
config disabled. See Version Updates for where
updates are surfaced.
Caps how many upstream tool calls may run at once, so a burst cannot overwhelm a fragile upstream. Off by default — with no keys set there is no limiting, no queueing and no new errors.
Three separately named scopes carry the same three settings:
| Scope | Where | What it caps |
|---|---|---|
| Global aggregate | top-level max_concurrent_requests / queue_size / queue_timeout | All upstream tool calls across the whole proxy |
| Per-server defaults | server_concurrency_defaults object | Blanket per-server values, inherited by servers that do not override them |
| Per-server override | the same three keys on an mcpServers[] entry | That one server |
{
"max_concurrent_requests": 50,
"queue_size": 100,
"queue_timeout": "30s",
"server_concurrency_defaults": {
"max_concurrent_requests": 5,
"queue_size": 10
},
"mcpServers": [
{ "name": "fragile-db", "command": "db-mcp", "max_concurrent_requests": 1, "queue_size": 2 },
{ "name": "fast-api", "url": "https://api.example.com/mcp", "max_concurrent_requests": 0 }
]
}
| Option | Type | Default | Description |
|---|---|---|---|
max_concurrent_requests | integer | unset (off) | Upstream tool calls allowed to run at once in this scope. 0 or unset = no limiter for this scope |
queue_size | integer | 0 | How many calls may wait for a slot. 0 = shed immediately at the cap |
queue_timeout | duration | "30s" when a limiter is active | How long a call may wait before being shed |
Tri-state per-server semantics. Each per-server key is independent: absent
inherits from server_concurrency_defaults, 0 disables that setting for
this server (max_concurrent_requests: 0 opts the server out of per-server
limiting entirely), and a positive value overrides the default.
The global limiter is never an inheritance source — it applies on top, so a
server's effective concurrency is min(per-server limit, global limit).
queue_timeout is one total wait budget across both tiers, not one per tier,
and queue waiting never eats into the call's execution timeout.
Shedding. A shed call gets a readable, retry-friendly error: an error tool
result for MCP calls, HTTP 429 with Retry-After for the REST tool-call
endpoint, and an activity record with the rejected status carrying the reason
(queue_full or queue_timeout) and scope (server or global). All limits
are hot-reloadable.
For stdio upstreams, start at 5 rather than 1: the transport multiplexes and
most SDK servers use a small worker pool.
Full reference — validation rules, metrics, and which origins are limited —
lives in docs/configuration.md
in the repository.
See Upstream Servers for detailed server configuration.
MCPProxy watches the configuration file for changes and automatically reloads when modifications are detected. No restart is required for most configuration changes.
Configuration options can be overridden using environment variables. See Environment Variables for details.