API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Mcp Servers

Create Mcp Server

mcp_servers.create(McpServerCreateParams**kwargs) -> McpServerCreateResponse

post/v1/mcp-servers/

List Mcp Servers

mcp_servers.list() -> McpServerListResponse

get/v1/mcp-servers/

Retrieve Mcp Server

mcp_servers.retrieve(strmcp_server_id) -> McpServerRetrieveResponse

get/v1/mcp-servers/{mcp_server_id}

Delete Mcp Server

mcp_servers.delete(strmcp_server_id)

delete/v1/mcp-servers/{mcp_server_id}

Update Mcp Server

mcp_servers.update(strmcp_server_id, McpServerUpdateParams**kwargs) -> McpServerUpdateResponse

patch/v1/mcp-servers/{mcp_server_id}

Refresh Mcp Server Tools

mcp_servers.refresh(strmcp_server_id, McpServerRefreshParams**kwargs) -> object

patch/v1/mcp-servers/{mcp_server_id}/refresh

ModelsExpand Collapse

class CreateSseMcpServer: …

Create a new SSE MCP server

server_url: str

The URL of the server

auth_header: Optional[str]

The name of the authentication header (e.g., 'Authorization')

auth_token: Optional[str]

The authentication token or API key value

custom_headers: Optional[Dict[str, str]]

Custom HTTP headers to include with requests

mcp_server_type: Optional[Literal["sse"]]

Accepts one of the following:

"sse"

class CreateStdioMcpServer: …

Create a new Stdio MCP server

args: List[str]

The arguments to pass to the command

command: str

The command to run (MCP 'local' client will run this command)

env: Optional[Dict[str, str]]

Environment variables to set

mcp_server_type: Optional[Literal["stdio"]]

Accepts one of the following:

"stdio"

class CreateStreamableHTTPMcpServer: …

Create a new Streamable HTTP MCP server

server_url: str

The URL of the server

auth_header: Optional[str]

The name of the authentication header (e.g., 'Authorization')

auth_token: Optional[str]

The authentication token or API key value

custom_headers: Optional[Dict[str, str]]

Custom HTTP headers to include with requests

mcp_server_type: Optional[Literal["streamable_http"]]

Accepts one of the following:

"streamable_http"

class SseMcpServer: …

An SSE MCP server

server_name: str

The name of the MCP server

server_url: str

The URL of the server

id: Optional[str]

The human-friendly ID of the Mcp_server

auth_header: Optional[str]

The name of the authentication header (e.g., 'Authorization')

auth_token: Optional[str]

The authentication token or API key value

custom_headers: Optional[Dict[str, str]]

Custom HTTP headers to include with requests

mcp_server_type: Optional[Literal["sse"]]

Accepts one of the following:

"sse"

class StdioMcpServer: …

A Stdio MCP server

args: List[str]

The arguments to pass to the command

command: str

The command to run (MCP 'local' client will run this command)

server_name: str

The name of the MCP server

id: Optional[str]

The human-friendly ID of the Mcp_server

env: Optional[Dict[str, str]]

Environment variables to set

mcp_server_type: Optional[Literal["stdio"]]

Accepts one of the following:

"stdio"

class StreamableHTTPMcpServer: …

A Streamable HTTP MCP server

server_name: str

The name of the MCP server

server_url: str

The URL of the server

id: Optional[str]

The human-friendly ID of the Mcp_server

auth_header: Optional[str]

The name of the authentication header (e.g., 'Authorization')

auth_token: Optional[str]

The authentication token or API key value

custom_headers: Optional[Dict[str, str]]

Custom HTTP headers to include with requests

mcp_server_type: Optional[Literal["streamable_http"]]

Accepts one of the following:

"streamable_http"

class UpdateSseMcpServer: …

Update schema for SSE MCP server - all fields optional

server_url: Optional[str]

The URL of the server

auth_header: Optional[str]

The name of the authentication header (e.g., 'Authorization')

auth_token: Optional[str]

The authentication token or API key value

custom_headers: Optional[Dict[str, str]]

Custom HTTP headers to include with requests

mcp_server_type: Optional[Literal["sse"]]

Accepts one of the following:

"sse"

class UpdateStdioMcpServer: …

Update schema for Stdio MCP server - all fields optional

args: Optional[List[str]]

The arguments to pass to the command

command: Optional[str]

The command to run (MCP 'local' client will run this command)

env: Optional[Dict[str, str]]

Environment variables to set

mcp_server_type: Optional[Literal["stdio"]]

Accepts one of the following:

"stdio"

class UpdateStreamableHTTPMcpServer: …

Update schema for Streamable HTTP MCP server - all fields optional

server_url: Optional[str]

The URL of the server

auth_header: Optional[str]

The name of the authentication header (e.g., 'Authorization')

auth_token: Optional[str]

The authentication token or API key value

custom_headers: Optional[Dict[str, str]]

Custom HTTP headers to include with requests

mcp_server_type: Optional[Literal["streamable_http"]]

Accepts one of the following:

"streamable_http"

Mcp ServersTools

List Tools For Mcp Server

mcp_servers.tools.list(strmcp_server_id) -> ToolListResponse

get/v1/mcp-servers/{mcp_server_id}/tools

Retrieve Mcp Tool

mcp_servers.tools.retrieve(strtool_id, ToolRetrieveParams**kwargs) -> Tool

get/v1/mcp-servers/{mcp_server_id}/tools/{tool_id}

Run Mcp Tool

mcp_servers.tools.run(strtool_id, ToolRunParams**kwargs) -> ToolExecutionResult

post/v1/mcp-servers/{mcp_server_id}/tools/{tool_id}/run