Sign in

v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-305398191.8 KB
connect

Create connection

Create a new MCP connection with an auto-generated ID. Requires API key and namespace ownership.

post/{namespace}

Path parameters

namespacestring required

Request body

transport'http' | 'uplink'

Connection transport. Use uplink for a local server paired over Smithery CLI.

mcpUrlstring uri

URL of a custom MCP server. For Smithery registry servers, prefer server.

serverstring

Smithery registry server qualified name. Use this instead of mcpUrl for registry servers.

namestring

Human-readable name (optional, defaults to connection ID)

metadataobject

Custom metadata for filtering connections

headersobject

Custom headers to send with MCP requests (stored securely, not returned in responses)

Example request

{
  "transport": "http",
  "mcpUrl": "https://mcp.example.com/sse",
  "server": "upstash/context7-mcp",
  "name": "My MCP Server",
  "metadata": {
    "userId": "user123",
    "team": "engineering"
  },
  "headers": {
    "X-API-Key": "secret-key"
  },
  "mock": {
    "scenario": "Slack workspace with an active #community-ops channel containing recent event-planning messages, plus 50 Airtable candidate records with mixed tenure and interests."
  }
}

Response

Connection created

connectionIdstring required

Connection ID (auto-generated or developer-defined)

namestring required

Human-readable name

transport'http' | 'uplink'

Connection transport

mcpUrlstring nullable required

MCP server URL. Null for uplink connections.

metadataobject nullable required
iconUrlstring nullable
createdAtstring

ISO 8601 timestamp

Example response

{
  "connectionId": "clever-dolphin-a9X3",
  "mock": {
    "scenario": "Slack workspace with an active #community-ops channel containing recent event-planning messages, plus 50 Airtable candidate records with mixed tenure and interests."
  }
}