Skip to navigation

Update MCP server

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, null clears it, and nested objects merge field by field. Lists of objects merge row by row instead of being replaced, so read the document first and send the whole list back when you reorder or remove rows. Lists of strings, Data Mapper expressions, JSON schemas, workflow_steps and resolver_methods are replaced whole. The id goes in the URL; if you also send id in the body it must match.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Path parameters

idstringRequired

The id of the MCP server, as returned when it was created or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
namestringOptional1-128 characters

Display name of the MCP server. Must be unique within the organization; up to 128 characters.

connector_idstringOptionalformat: "uuid">=1 character

Connector that provides the MCP server’s base URL and authentication. The connector must use an authentication type supported for MCP servers. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

pathstringOptional

Path appended to the connector’s base URL to reach the MCP endpoint, for example ‘/mcp’. Must start with ’/’ when set.

enabledbooleanOptional
If true, the MCP server is available for use. Defaults to false.
descriptionstringOptional<=1024 characters
Description of what this MCP server does. Up to 1024 characters.
launch_configobjectOptional
Which users the MCP server and its tools are available to. If no audience is set, it is available to all users.
tool_confirmation_modeenumOptional

When users must confirm before a tool on this server runs: always, never, or server-guided. Defaults to server-guided, which follows the server’s own tool annotations.

Allowed values:

Response

The updated MCP server, at its new version
idstringOptionalRead-only
Unique identifier of the MCP server, assigned by the server.
namestringOptional1-128 characters

Display name of the MCP server. Must be unique within the organization; up to 128 characters.

connector_idstringOptionalformat: "uuid">=1 character

Connector that provides the MCP server’s base URL and authentication. The connector must use an authentication type supported for MCP servers. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

pathstringOptional

Path appended to the connector’s base URL to reach the MCP endpoint, for example ‘/mcp’. Must start with ’/’ when set.

enabledbooleanOptional
If true, the MCP server is available for use. Defaults to false.
descriptionstringOptional<=1024 characters
Description of what this MCP server does. Up to 1024 characters.
launch_configobjectOptional
Which users the MCP server and its tools are available to. If no audience is set, it is available to all users.
tool_confirmation_modeenumOptional

When users must confirm before a tool on this server runs: always, never, or server-guided. Defaults to server-guided, which follows the server’s own tool annotations.

Allowed values:
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error