docs/features/version-updates.md
MCPProxy includes built-in update checking to help you stay current with the latest features and security fixes.
MCPProxy automatically checks for new versions by querying GitHub Releases:
When an update is available, a new menu item appears in the tray menu:
The menu item only appears when an update is detected - no menu clutter when you're up to date.
The sidebar displays the current version at the bottom. When an update is available:
The dashboard additionally shows a dismissible update banner ("Update available: vX — you are running vY") with a release-notes link. Dismissal is per version: dismissing the banner for v1.3.0 keeps it hidden for v1.3.0 (persisted in the browser), but the banner reappears when a newer release becomes available. The banner is non-modal and never blocks the UI.
The mcpproxy doctor command shows version information:
$ mcpproxy doctor
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
🔍 MCPProxy Health Check
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Version: v1.2.3 (update available: v1.3.0)
Download: https://github.com/smart-mcp-proxy/mcpproxy-go/releases/tag/v1.3.0
✅ All systems operational! No issues detected.
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
update_check)Update checking is controlled from mcp_config.json via the update_check
block:
{
"update_check": {
"enabled": true,
"channel": "stable"
}
}
| Option | Type | Default | Description |
|---|---|---|---|
enabled | boolean | true | Master switch. When false, no network check is performed (background poll and the manual re-check) and no upgrade nudge appears on any surface — the update object is omitted from /api/v1/info. |
channel | string | "stable" | Release channel: "stable" (GitHub releases/latest; prereleases never offered) or "rc" (prerelease tags such as v0.47.0-rc.1 included). |
Both keys are hot-reloadable: editing the config file or applying it via
POST /api/v1/config/apply takes effect without a restart. Re-enabling (or
switching channels) triggers a prompt re-check instead of waiting for the next
4-hour tick.
enabled: false also gates the Go tray's built-in daily self-update check, so
no surface performs a network check while disabled. The tray does not read
mcp_config.json itself (it holds no state); instead it asks the core via
GET /api/v1/info before checking — the core omits the update object when
update checking is disabled, and the tray then skips its own network check. If
the core is unreachable the tray skips that tick and retries, rather than
falling open to a check the operator may have disabled. The tray's own check
still selects prereleases via MCPPROXY_ALLOW_PRERELEASE_UPDATES only —
converging it fully onto the shared checker (including channel) is a separate
Spec 079 work item (FR-001a).
| Variable | Description | Default |
|---|---|---|
MCPPROXY_DISABLE_AUTO_UPDATE | Disable background update checks entirely | false |
MCPPROXY_ALLOW_PRERELEASE_UPDATES | Include prerelease/beta versions in update checks | false |
The environment switches win over the update_check config keys — they
are the operator override:
MCPPROXY_DISABLE_AUTO_UPDATE=true disables checking even when
update_check.enabled is true.MCPPROXY_ALLOW_PRERELEASE_UPDATES=true selects the prerelease channel even
when update_check.channel is "stable".The env vars only widen in one direction (disable checks / include
prereleases). They cannot re-enable checking that the config disabled: with
update_check.enabled: false, no check runs regardless of environment.
# Disable update checking (config file — persistent, hot-reloads)
# "update_check": { "enabled": false }
# Disable update checking (environment — wins over config)
MCPPROXY_DISABLE_AUTO_UPDATE=true mcpproxy serve
# Opt in to prerelease (RC) updates via config
# "update_check": { "channel": "rc" }
# Enable prerelease updates via environment (for beta testers)
MCPPROXY_ALLOW_PRERELEASE_UPDATES=true mcpproxy serve
Update information is available via the REST API:
curl -H "X-API-Key: your-key" http://127.0.0.1:8080/api/v1/info
Response includes an update field when version information is available:
{
"success": true,
"data": {
"version": "v1.2.3",
"update": {
"available": true,
"latest_version": "v1.3.0",
"release_url": "https://github.com/smart-mcp-proxy/mcpproxy-go/releases/tag/v1.3.0",
"checked_at": "2025-01-15T10:30:00Z",
"is_prerelease": false
}
}
}
See REST API Documentation for complete details.
brew upgrade mcpproxy
Download the latest .msi installer from GitHub Releases and run it. The installer will upgrade your existing installation.
When running a development build (version shows as "development"), update checking is automatically disabled since there's no meaningful version to compare against.
MCPPROXY_DISABLE_AUTO_UPDATE is set, or update_check.enabled is false in mcp_config.jsonmcpproxy doctor to see current version statustail -f ~/.mcpproxy/logs/main.log | grep -i update
By default, prerelease versions are excluded. To enable, set
"update_check": { "channel": "rc" } in mcp_config.json, or:
export MCPPROXY_ALLOW_PRERELEASE_UPDATES=true
MCPProxy checks updates via https://api.github.com. Ensure this domain is accessible from your network.