POST /v1/redpanda-connect/mcp-servers

Create a new Redpanda Connect MCP Server.

application/json

Body Required

  • description string

    MCP server description.

  • display_name string Required

    User-friendly MCP server name.

  • resources object
    Hide resources attributes Show resources attributes object
    • cpu_shares string Required

      cpu_shares is a string specifying the amount of CPU to allocate for the pipeline.

      This follows the Kubernetes quantity format. Acceptable units include:

      • Decimal SI units: "m" (e.g., "500m" for 500 millicores, "2" for 2 cores) CPU shares can be specified in millicores (1 core = 1000 millicores). If you don't specify a unit, the value is interpreted as the number of cores.
    • memory_shares string Required

      memory_shares is a string specifying the amount of memory to allocate for the pipeline.

      This follows the Kubernetes quantity format. Acceptable units include:

      • Decimal SI units: "K", "M", "G", "T", "P", "E" (e.g., "128M" for 128 megabytes)
      • Binary SI units: "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" (e.g., "512Mi" for 512 mebibytes) If you don't specify a unit, the value is interpreted as bytes.
  • service_account object Required
    Hide service_account attributes Show service_account attributes object
    • client_id string Required
    • client_secret string Required
  • tags object

    Optional list of tags to attach to a MCP server.

    Hide tags attribute Show tags attribute object
    • * string Additional properties
  • tools object Required

    The Redpanda Connect MCP server configuration.

    Hide tools attribute Show tools attribute object
    • * object Additional properties

      A configuration tool for the MCP server.

      Hide * attributes Show * attributes object
      • component_type string

        Component type for this tool.

        Values are COMPONENT_TYPE_PROCESSOR, COMPONENT_TYPE_CACHE, COMPONENT_TYPE_INPUT, or COMPONENT_TYPE_OUTPUT.

      • config_yaml string Required

        The contents of the configuration tool in YAML format.

Responses

  • 201 application/json

    OK

    Hide response attributes Show response attributes object
    • description string

      Optional MCP server description.

    • display_name string Required

      User-friendly MCP server name.

    • id string Required

      MCP Server ID.

    • resources object
      Hide resources attributes Show resources attributes object
      • cpu_shares string Required

        cpu_shares is a string specifying the amount of CPU to allocate for the pipeline.

        This follows the Kubernetes quantity format. Acceptable units include:

        • Decimal SI units: "m" (e.g., "500m" for 500 millicores, "2" for 2 cores) CPU shares can be specified in millicores (1 core = 1000 millicores). If you don't specify a unit, the value is interpreted as the number of cores.
      • memory_shares string Required

        memory_shares is a string specifying the amount of memory to allocate for the pipeline.

        This follows the Kubernetes quantity format. Acceptable units include:

        • Decimal SI units: "K", "M", "G", "T", "P", "E" (e.g., "128M" for 128 megabytes)
        • Binary SI units: "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" (e.g., "512Mi" for 512 mebibytes) If you don't specify a unit, the value is interpreted as bytes.
    • service_account object Required
      Hide service_account attributes Show service_account attributes object
      • client_id string Required
      • client_secret string Required
    • state string

      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.

      Values are STATE_STARTING, STATE_RUNNING, STATE_STOPPING, STATE_STOPPED, or STATE_ERROR.

    • status object

      MCP server status may contain an error message.

      Hide status attribute Show status attribute object
      • error string
    • tags object

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

      Hide tags attribute Show tags attribute object
      • * string Additional properties
    • tools object Required

      The Redpanda Connect MCP server configuration.

      Hide tools attribute Show tools attribute object
      • * object Additional properties

        A configuration tool for the MCP server.

        Hide * attributes Show * attributes object
        • component_type string

          Component type for this tool.

          Values are COMPONENT_TYPE_PROCESSOR, COMPONENT_TYPE_CACHE, COMPONENT_TYPE_INPUT, or COMPONENT_TYPE_OUTPUT.

        • config_yaml string Required

          The contents of the configuration tool in YAML format.

    • url string
  • 401 application/json

    Unauthenticated.

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.

  • 500 application/json

    Internal Server Error. Reach out to support.

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.

  • default application/json

    An unexpected error response.

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.

POST /v1/redpanda-connect/mcp-servers
curl \
 --request POST 'https://{dataplane_api_subdomain}.cloud.redpanda.com/v1/redpanda-connect/mcp-servers' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"description":"string","display_name":"string","resources":{"cpu_shares":"string","memory_shares":"string"},"service_account":{"client_id":"string","client_secret":"string"},"tags":{"additionalProperty1":"string","additionalProperty2":"string"},"tools":{"additionalProperty1":{"component_type":"COMPONENT_TYPE_PROCESSOR","config_yaml":"string"},"additionalProperty2":{"component_type":"COMPONENT_TYPE_PROCESSOR","config_yaml":"string"}}}'
Request examples
{
  "description": "string",
  "display_name": "string",
  "resources": {
    "cpu_shares": "string",
    "memory_shares": "string"
  },
  "service_account": {
    "client_id": "string",
    "client_secret": "string"
  },
  "tags": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "tools": {
    "additionalProperty1": {
      "component_type": "COMPONENT_TYPE_PROCESSOR",
      "config_yaml": "string"
    },
    "additionalProperty2": {
      "component_type": "COMPONENT_TYPE_PROCESSOR",
      "config_yaml": "string"
    }
  }
}
Response examples (201)
{
  "description": "string",
  "display_name": "string",
  "id": "string",
  "resources": {
    "cpu_shares": "string",
    "memory_shares": "string"
  },
  "service_account": {
    "client_id": "string",
    "client_secret": "string"
  },
  "state": "STATE_STARTING",
  "status": {
    "error": "string"
  },
  "tags": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "tools": {
    "additionalProperty1": {
      "component_type": "COMPONENT_TYPE_PROCESSOR",
      "config_yaml": "string"
    },
    "additionalProperty2": {
      "component_type": "COMPONENT_TYPE_PROCESSOR",
      "config_yaml": "string"
    }
  },
  "url": "string"
}
Response examples (401)
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}
Response examples (500)
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}
Response examples (default)
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}

Documentation preview

will expire on December 14 at 02:50

This is a preview of your version @2025-12-07.