Skip to main content
POST
Create Mcp Server Instance

Authorizations

Authorization
string
header
required

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

Body

application/json

Payload for creating an MCP server instance.

json_spec carries the connection configuration. Common shapes:

  • {"type": "url", "endpoint_url": "https://..."}
  • {"type": "docker", "environment": {...}, "env_vars": [...]}
  • {"type": "command", "command": [...], "environment": {...}} For URL-type instances the service synchronously verifies the endpoint; docker/command kick off background verification.
json_spec
Json Spec · object
required

Connection configuration. Must include 'type' ('url' | 'docker' | 'command'); other keys depend on type.

name
string
required

Display name for this MCP server instance (unique per workspace).

Required string length: 1 - 255
server_spec_id
string
required

ID of an existing MCP server spec to derive defaults from (env_schema, secret routing, etc.).

auth_config_id
string | null

ID of an MCP auth config (OAuth/credentials) to attach.

description
string | null

Optional human-readable description of the instance.

Response

Successful Response

created_at
string
required
description
string | null
required
id
string<uuid>
required
json_spec
Json Spec · object
required
name
string
required
server_spec_id
string
required
updated_at
string
required
verification
Verification · object
required
auth_config_id
last_dispatch
Last Dispatch · object | null
tools
Tools · object[] | null