Skip to main content
PATCH
Save the MCP server configuration
Replaces this deployment’s MCP server configuration, as the Forge Console’s MCP configuration page saves it: whether the hosted MCP server serves the deployment (enabled), which tool groups it serves (enabledToolGroups; empty means every group), per-group instructions (toolGroupInstructions), and globalInstructions, which are sent to every MCP client this deployment serves. globalInstructions is at most 4,000 characters; a longer value is 400 bad_request and nothing is saved. Your role grants, narrowed by your credential’s scopes, must hold apikeys:manage at the platform scope; a grant at an org unit does not count. The audit trail records one mcp_config_updated event with the configuration before and after, naming the credential (a Personal key: its owner and the key). The answer is the saved configuration. With an Idempotency-Key, a retry within 24 hours returns the recorded result while you still hold apikeys:manage at the platform scope.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Body

application/json

The whole MCP server configuration, replacing the saved one.

enabled
boolean
required

Whether the hosted MCP server serves this deployment.

enabledToolGroups
string[]
required

The tool groups served. Empty: every group.

Minimum string length: 1
toolGroupInstructions
object[]
required

Per-group instructions. Empty: none.

globalInstructions
string

Instructions sent to every MCP client this deployment serves (at most 4000 characters). Absent: none.

Maximum string length: 4000

Response

The saved configuration

data
object
required

The saved MCP server configuration. globalInstructions is absent when there are none.

meta
object
required