Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Unique identifier of the MCP gateway.

Body

application/json
key
string

Rejected with INVALID_ARGUMENT: the key backs the gateway's public MCP URL and is immutable after creation. Retained so callers get an error rather than a silently ignored field.

display_name
string

Human readable name shown in the workspace.

description
string

Free-form note about what this gateway is for.

Replaces the current links. An empty array is treated as no change; use clear_server_links to remove them all.

tool_naming
enum<string>

How upstream tool names are namespaced before they are exposed.

Available options:
MCP_TOOL_NAMING_UNSPECIFIED,
MCP_TOOL_NAMING_PREFIX_WITH_SERVER_KEY,
MCP_TOOL_NAMING_PREFIX_ON_COLLISION
status
enum<string>

ACTIVE serves MCP traffic; DISABLED rejects it while keeping the configuration.

Available options:
MCP_GATEWAY_STATUS_UNSPECIFIED,
MCP_GATEWAY_STATUS_ACTIVE,
MCP_GATEWAY_STATUS_DISABLED
mode
enum<string>

Shape of the tool surface presented to MCP clients: CODE or DIRECT.

Available options:
MCP_GATEWAY_MODE_UNSPECIFIED,
MCP_GATEWAY_MODE_CODE,
MCP_GATEWAY_MODE_DIRECT
sharing
object

Which projects in the workspace may use this gateway. Defaults to every project.

Set true to remove every link; cannot be combined with server_links.

Response

200 - application/json

OK

mcp_gateway
object