Partially Update MCP Server

Pre-release Endpoint
This endpoint is currently in beta and is subject to change.

Partially update an individual MCP server.

patch

Path Parameters

mcpServerIdstring(uuid)required

The ID of the MCP server.

Body

application/json

PatchMCPServerRequest

namestring

The name of the MCP server.

>= 1 characters<= 256 characters

descriptionstring | null

A description of the MCP server.

<= 1024 characters

labelsobject | null

Labels for the MCP server.

deployed_atstring | null(date-time)

The timestamp when the MCP server was deployed.

control_plane_idstring | null(uuid)

The control plane ID associated with the MCP server.

resource_idstring | null(uuid)

The MCP resource ID associated with the MCP server.

Response

application/json

A response to updating an MCP server.

MCPServerInfo

idstring(uuid)required

The unique identifier for the MCP server.

namestringrequired

The name of the MCP server.

>= 1 characters<= 256 characters

descriptionstring

A description of the MCP server.

<= 1024 characters

labelsobject

Labels for the MCP server.

deployed_atstring(date-time)

The timestamp when the MCP server was deployed.

control_plane_idstring | null(uuid)

The control plane ID associated with the MCP server.

resource_idstring | null(uuid)

The MCP resource ID associated with the MCP server.

versionstringrequired

The version of the MCP server.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

patch/mcp-servers/{mcpServerId}

Body

{}
 
application/json

Delete MCP Server

Pre-release Endpoint
This endpoint is currently in beta and is subject to change.

Delete an MCP server.

delete

Path Parameters

mcpServerIdstring(uuid)required

The ID of the MCP server.

Response

Successfully deleted MCP server.

delete/mcp-servers/{mcpServerId}
 

Get MCP Server deployment status

Pre-release Endpoint
This endpoint is currently in beta and is subject to change.

Returns the current aggregated deployment status of an MCP server.

get

Path Parameters

mcpServerIdstring(uuid)required

The ID of the MCP server.

Response

application/json

Deployment status of the MCP server.

MCPServerStatusResponse

statusstringrequired

Aggregated deployment status of the MCP server.

  • deploying — single version with desired replicas not yet fully ready.
  • healthy — single version running with no failing pods.
  • pending — no deployment status has been reported yet.
  • unhealthy — one or more failing pods across any version.
  • upgrading — multiple versions running with no failing pods.

Allowed values:deployinghealthypendingunhealthyupgrading

Example:healthy

get/mcp-servers/{mcpServerId}/status
 
application/json

List MCP Server Tools

Pre-release Endpoint
This endpoint is currently in beta and is subject to change.

Returns an array of MCP server tool objects.

get

Query Parameters

include_layout_metadataboolean

Determines whether layout metadata is included in the response.

Default:false

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter documents returned in the response.

Show Child Parameters

Path Parameters

mcpServerIdstring(uuid)required

The ID of the MCP server.

Response

application/json

A response to listing MCP server tools.

ListMCPServerToolsResponse

dataarrayrequired
Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
get/mcp-servers/{mcpServerId}/tools
 
application/json

Create MCP Server Tool

Pre-release Endpoint
This endpoint is currently in beta and is subject to change.

Create an MCP server tool under the specified MCP server.

post

Path Parameters

mcpServerIdstring(uuid)required

The ID of the MCP server.

Body

application/json

MCPServerToolInput

namestringrequired

The unique name of the MCP server tool.

Match pattern:^[\w_-]+$

>= 1 characters<= 255 characters

statestring

The state of the MCP server tool.

Allowed values:draftpublished

Default:draft

definitionarray[object]
* Additional properties are allowed.
definition_draftarray[object]
* Additional properties are allowed.
layout_metadataobject

Layout metadata for the MCP server tool.

* Additional properties are allowed.

Response

application/json

A response to creating an MCP server tool.

MCPServerTool

namestringrequired

The unique name of the MCP server tool.

Match pattern:^[\w_-]+$

>= 1 characters<= 255 characters

statestring

The state of the MCP server tool.

Allowed values:draftpublished

Default:draft

definitionarray[object]
* Additional properties are allowed.
definition_draftarray[object]
* Additional properties are allowed.
layout_metadataobject

Layout metadata for the MCP server tool.

* Additional properties are allowed.
idstring(uuid)required

The unique identifier for the MCP server tool.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/mcp-servers/{mcpServerId}/tools

Body

{ "name": "name" }
 
application/json