Sign in
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.

Changes

Changed in 6 of the 51 revisions of this API.316

  • 1a5d7b6e57622See the full diff
    • ○

      api tag Remote MCP added

      api-tag-added

    • ○

      api tag Redpanda Connect MCP servers removed

      api-tag-removed

  • 87688d3474c21See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 13b59123fea01See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d7649071e8e1112See the full diff
    • ▲

      removed the required property config_files from the response with the 200 status

      response-required-property-removed

    • ●

      removed the request property config_files

      request-property-removed

    • ○

      added the new optional request property tools

      new-optional-request-property

    • ○

      added the required property tools to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a797fd06fd451See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dfa71f9d277e1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 121 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog