Sign in

v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
Tool Servers

Create tool server

Creates a tool server that exposes tools for use by agents.

post/v2/tool_servers

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Request body

namestring required

The human-readable name of a tool server.

type'mcp' required

The type of tool server.

descriptionstring

A detailed description of what this tool server does.

uristring uri required

The URI of the tool server.

headersobject

Optional HTTP headers to include when connecting to the server.

transport'sse' | 'streamable-http' required

Transport protocol for MCP server connections. Both use Server-Sent Events (SSE).

enabledboolean

Whether the tool server is currently enabled and available for use.

metadataobject

Arbitrary metadata associated with the tool server.

Example request

{
  "name": "RAG Search Server",
  "type": "mcp",
  "description": "Provides RAG search capabilities for documents.",
  "uri": "https://api.example.com/rag_search",
  "transport": "sse",
  "auth": {
    "type": "bearer",
    "token": "abcdef......"
  }
}

Response

The created tool server details.

idstring

Unique identifier for a tool server.

namestring required

The human-readable name of a tool server.

type'mcp' required

The type of tool server.

descriptionstring

A detailed description of what this tool server does.

uristring uri required

The URI of the server.

headersobject

Optional HTTP headers to include when connecting to the server.

transport'sse' | 'streamable-http' required

Transport protocol for MCP server connections. Both use Server-Sent Events (SSE).

enabledboolean required

Whether the tool server is currently enabled and available for use.

metadataobject

Arbitrary metadata associated with the tool server.

created_atstring date-time

Timestamp when the tool server was created.

updated_atstring date-time

Timestamp when the tool server was last updated.

Example response

{
  "id": "tsr_rag_search",
  "name": "RAG Search Server",
  "type": "mcp",
  "description": "Provides RAG search capabilities for documents.",
  "uri": "https://api.example.com/sse/",
  "headers": {
    "Content-Type": "application/json"
  },
  "transport": "sse",
  "metadata": {
    "version": "1.0"
  }
}