Skip to main content
POST
Create Mcp Server Connection

Authorizations

Authorization
string
header
required

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

Path Parameters

workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json
instance
MCPServerInstanceCreateWithoutSpec · object
required
server
MCPServerCreate · object
required

Payload for creating an MCP server spec (catalog template).

Either docker_image_url (for container-based servers) or remote_url (for HTTP-based servers like GitHub Copilot) should be supplied. env_schema describes the variables an instance built from this spec needs to provide; secret entries (isSecret: true) are routed through the secret manager rather than stored in plaintext.

Response

Successful Response

created_at
string<date-time>
required
description
string | null
required
id
string<uuid>
required
json_spec
Json Spec · object
required
name
string
required
server_spec_id
string
required
transport
enum<string>
required

How a connection is reached: the instance's transport column, set once at creation.

Available options:
url,
docker,
command,
bundle
updated_at
string<date-time>
required
verification
Verification · object
required
auth_config_id
cost
Cost · object | null
events
Events · object | null
last_dispatch
Last Dispatch · object | null
managed_by
string | null
tools
Tools · object[] | null