Sign in

v50

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-0193273218.8 KB
Remote MCP

Update an MCP server

Update the configuration of an MCP server.

put/v1/redpanda-connect/mcp-servers/{id}

Path parameters

idstring required

MCP server ID.

Query parameters

update_maskstring

Specifies which fields to update. If not provided, updates all fields.

Request body

descriptionstring

MCP server description.

display_namestring

User-friendly MCP server name.

tagsobject

A map of tags to add, update or delete. If a tag's value is empty, the server interprets that as a deletion.

toolsobject

Map of tool names to their configurations. Each tool defines a capability that the MCP server exposes.

Response

OK

descriptionstring

Optional MCP server description.

display_namestring required

User-friendly MCP server name.

idstring required

Unique identifier for the MCP server.

state'STATE_STARTING' | 'STATE_RUNNING' | 'STATE_STOPPING' | 'STATE_STOPPED' | 'STATE_ERROR'

State of the MCP server.

  • STATE_STARTING: The MCP server is starting.
  • STATE_RUNNING: The MCP server is running.
  • STATE_STOPPING: The MCP server is in the process of stopping.
  • STATE_STOPPED: The MCP server is stopped and in paused state.
  • STATE_ERROR: The MCP server encountered an error.
tagsobject

Tags are key-value pairs that can be assigned to an MCP server resource. They help organize MCP servers and enable filtering when listing them.

toolsobject required

Map of tool names to their configurations. Each tool defines a capability that the MCP server exposes.

urlstring

URL to connect to the MCP server.