Skip to main content
POST
Core - Create MCP gateway

Authorizations

Authorization
string
header
required

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

Body

application/json
key
string
required

Lowercase slug of letters, digits, hyphens and underscores, max 64 characters, unique per workspace; backs the gateway's public MCP URL.

display_name
string
required

Human readable name shown in the workspace.

description
string

Free-form note about what this gateway is for.

Upstream servers this gateway aggregates.

tool_naming
enum<string>

How upstream tool names are namespaced before they are exposed. Defaults to PREFIX_ON_COLLISION.

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

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

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.

Response

200 - application/json

OK

mcp_gateway
object