Webinar: Better Agents, Easier than Ever — Thursday, June 18th at 9am PT / 12pm ET. Register Now
Version 2.5
MCP servers

MCP servers

Manage the MCP servers registered in the workspace — the tool providers agents attach to. To attach a server to a specific agent, see Agents. To talk to an agent as an MCP server, see Agent MCP.

All paths are relative to the base URL and require an Authorization: Bearer YOUR_API_KEY header.

The MCP server object

PublicMcpServer:

FieldTypeDescription
idstringServer ID.
namestringDisplay name.
transportstringHow the server is reached (e.g. streamable-http, sse, stdio).
urlstringEndpoint URL (remote transports).
headersobjectHeaders sent with each request (remote transports).
commandstringExecutable to run (local stdio transport).
argsarrayArguments for the command.
envobjectEnvironment variables for the command.
cwdstringWorking directory for the command.
force_serial_tool_callsbooleanRun this server's tool calls one at a time.

List MCP servers

GET /mcp-servers

Returns a PaginatedResponse of MCP servers.

Get an MCP server

GET /mcp-servers/{mcp_server_id}

Returns a single PublicMcpServer.

Create an MCP server

POST /mcp-servers

Registers a new MCP server. Provide the connection details for the server's transport — url/headers for a remote server, or command/args/env/cwd for a local one.

Body

FieldTypeRequiredDescription
namestringYesDisplay name.
transportstringNoTransport type.
urlstringNoEndpoint URL (remote).
headersobjectNoRequest headers (remote).
commandstringNoExecutable (local stdio).
argsarrayNoCommand arguments.
envobjectNoCommand environment variables.
cwdstringNoCommand working directory.
force_serial_tool_callsbooleanNoSerialize this server's tool calls.
type / icon / organization_typestringNoDisplay and categorization metadata.
oauth_client_configobjectNoOAuth client config for servers that act on a user's behalf.
curl -X POST 'https://{your-deployment-host}/tenants/{tenant-id}/api/v2/mcp-servers' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Weather",
    "transport": "streamable-http",
    "url": "https://mcp.example.com/weather"
  }'

Returns the created PublicMcpServer.

Update an MCP server

PUT /mcp-servers/{mcp_server_id}

Updates a server. Takes the same body as create. Returns the updated PublicMcpServer.

Delete an MCP server

DELETE /mcp-servers/{mcp_server_id}

Deletes a server. Returns 204 No Content.