Skip to content

Commit a57267a

Browse files
vbotbuildovichkbatuigas
vbotbuildovich
and
kbatuigas
authored
auto-docs: Update Cloud API spec (#49)
* auto-docs: Update Cloud API spec * Apply suggestions from code review --------- Co-authored-by: Kat Batuigas <[email protected]>
1 parent b05c46b commit a57267a

File tree

1 file changed

+55
-55
lines changed

1 file changed

+55
-55
lines changed

‎cloud-dataplane/cloud-dataplane.yaml‎

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,7 @@ components:
495495
component_type:
496496
$ref: '#/components/schemas/ComponentType'
497497
config_schema:
498-
description: JSON schema of the configuration components that are allowed for MCP Servers.
498+
description: JSON schema of the configuration components that are allowed for MCP servers.
499499
type: string
500500
type: object
501501
ConnectCluster:
@@ -1223,7 +1223,7 @@ components:
12231223
GetMCPServerServiceConfigSchemaResponse:
12241224
properties:
12251225
configuration_yamls:
1226-
description: The configuration schema for the MCP Server.
1226+
description: The configuration schema for the MCP server.
12271227
items:
12281228
$ref: '#/components/schemas/ConfigurationYAMLSchema'
12291229
type: array
@@ -1484,7 +1484,7 @@ components:
14841484
tools:
14851485
additionalProperties:
14861486
$ref: '#/components/schemas/Tool'
1487-
description: The Redpanda Connect MCP tools configuration in YAML format.
1487+
description: Map of tool names to their configurations. Each tool contains YAML configuration.
14881488
type: object
14891489
required:
14901490
- tools
@@ -1494,7 +1494,7 @@ components:
14941494
lint_hints:
14951495
additionalProperties:
14961496
$ref: '#/components/schemas/LintHint'
1497-
description: A list of linting issues.
1497+
description: Map of tool names to their linting issues. Empty if no issues are found.
14981498
type: object
14991499
type: object
15001500
LintPipelineConfigRequest:
@@ -1637,15 +1637,15 @@ components:
16371637
ListMCPServersRequest.Filter:
16381638
properties:
16391639
display_name_contains:
1640-
description: Any MCP Server that partially match this name will be returned.
1640+
description: Returns MCP servers that partially match this name.
16411641
type: string
16421642
secret_id:
1643-
description: Match MCP servers that use this secret ID.
1643+
description: Filters MCP servers that reference this secret ID in their tool configurations.
16441644
type: string
16451645
tags[string]:
16461646
additionalProperties:
16471647
type: string
1648-
description: MCP servers that match all the provided tags will be returned.
1648+
description: Filters by tags using exact match. Returns only MCP servers that have all the specified key-value pairs.
16491649
type: object
16501650
type: object
16511651
ListMCPServersResponse:
@@ -1655,6 +1655,7 @@ components:
16551655
$ref: '#/components/schemas/MCPServer'
16561656
type: array
16571657
next_page_token:
1658+
description: Token to retrieve the next page of results. Empty if there are no more results.
16581659
type: string
16591660
type: object
16601661
ListMountTasksResponse:
@@ -1947,7 +1948,7 @@ components:
19471948
description: User-friendly MCP server name.
19481949
type: string
19491950
id:
1950-
description: MCP Server ID.
1951+
description: Unique identifier for the MCP server.
19511952
type: string
19521953
resources:
19531954
$ref: '#/components/schemas/Resources'
@@ -1961,17 +1962,17 @@ components:
19611962
additionalProperties:
19621963
type: string
19631964
description: |-
1964-
Tags are key-value pairs that can be assigned to a MCP server resource.
1965+
Tags are key-value pairs that can be assigned to an MCP server resource.
19651966
They help organize MCP servers and enable filtering when listing them.
19661967
type: object
19671968
tools:
19681969
additionalProperties:
19691970
$ref: '#/components/schemas/Tool'
1970-
description: The Redpanda Connect MCP server configuration.
1971+
description: Map of tool names to their configurations. Each tool defines a capability that the MCP server exposes.
19711972
type: object
19721973
url:
1974+
description: URL to connect to the MCP server.
19731975
readOnly: true
1974-
title: URL to connect to the MCP server
19751976
type: string
19761977
required:
19771978
- id
@@ -2009,13 +2010,14 @@ components:
20092010
description: MCP server status may contain an error message.
20102011
properties:
20112012
error:
2013+
description: Error message if the MCP server is in an error state. Empty if no error.
20122014
type: string
20132015
type: object
20142016
MCPServerCreate:
2015-
description: MCPServerCreate contains the details for the MCP Server creation request.
2017+
description: MCPServerCreate contains the details for the MCP server creation request.
20162018
properties:
20172019
description:
2018-
description: MCP server description.
2020+
description: Optional MCP server description.
20192021
type: string
20202022
display_name:
20212023
description: User-friendly MCP server name.
@@ -2027,12 +2029,12 @@ components:
20272029
tags:
20282030
additionalProperties:
20292031
type: string
2030-
description: Optional list of tags to attach to a MCP server.
2032+
description: Optional list of tags to attach to an MCP server.
20312033
type: object
20322034
tools:
20332035
additionalProperties:
20342036
$ref: '#/components/schemas/Tool'
2035-
description: The Redpanda Connect MCP server configuration.
2037+
description: Map of tool names to their configurations. Each tool defines a capability that the MCP server exposes.
20362038
type: object
20372039
required:
20382040
- display_name
@@ -2045,7 +2047,7 @@ components:
20452047
description: MCP server description.
20462048
type: string
20472049
display_name:
2048-
description: User-friendly MCP servers name.
2050+
description: User-friendly MCP server name.
20492051
type: string
20502052
resources:
20512053
$ref: '#/components/schemas/Resources'
@@ -2061,7 +2063,7 @@ components:
20612063
tools:
20622064
additionalProperties:
20632065
$ref: '#/components/schemas/Tool'
2064-
description: The Redpanda Connect MCP server configuration.
2066+
description: Map of tool names to their configurations. Each tool defines a capability that the MCP server exposes.
20652067
type: object
20662068
type: object
20672069
MatchingACL:
@@ -5578,10 +5580,10 @@ paths:
55785580
- Redpanda Connect Pipelines
55795581
/v1/redpanda-connect/mcp-servers:
55805582
get:
5581-
description: 'List Redpanda Connect MCP Servers. Optional: filter based on MCP server name.'
5583+
description: Lists MCP servers. Optionally filter by display name, tags, or secret ID.
55825584
operationId: MCPServerService_ListMCPServers
55835585
parameters:
5584-
- description: Any MCP Server that partially match this name will be returned.
5586+
- description: Returns MCP servers that partially match this name.
55855587
in: query
55865588
name: filter.display_name_contains
55875589
schema:
@@ -5591,7 +5593,7 @@ paths:
55915593
name: filter.tags[string]
55925594
schema:
55935595
type: string
5594-
- description: Match MCP servers that use this secret ID.
5596+
- description: Filters MCP servers that reference this secret ID in their tool configurations.
55955597
in: query
55965598
name: filter.secret_id
55975599
schema:
@@ -5634,11 +5636,11 @@ paths:
56345636
schema:
56355637
$ref: '#/components/schemas/rpc.Status'
56365638
description: An unexpected error response.
5637-
summary: List Redpanda Connect MCP Servers
5639+
summary: List MCP servers
56385640
tags:
5639-
- Redpanda Connect MCP servers
5641+
- Remote MCP
56405642
post:
5641-
description: Create a new Redpanda Connect MCP Server.
5643+
description: Create a new MCP server.
56425644
operationId: MCPServerService_CreateMCPServer
56435645
requestBody:
56445646
content:
@@ -5672,15 +5674,15 @@ paths:
56725674
schema:
56735675
$ref: '#/components/schemas/rpc.Status'
56745676
description: An unexpected error response.
5675-
summary: Create Redpanda Connect MCP Server
5677+
summary: Create MCP server
56765678
tags:
5677-
- Redpanda Connect MCP servers
5679+
- Remote MCP
56785680
/v1/redpanda-connect/mcp-servers/{id}:
56795681
delete:
5680-
description: Delete a Redpanda Connect MCP server.
5682+
description: Delete an MCP server.
56815683
operationId: MCPServerService_DeleteMCPServer
56825684
parameters:
5683-
- description: MCP Server ID.
5685+
- description: MCP server ID.
56845686
in: path
56855687
name: id
56865688
required: true
@@ -5716,11 +5718,11 @@ paths:
57165718
schema:
57175719
$ref: '#/components/schemas/rpc.Status'
57185720
description: An unexpected error response.
5719-
summary: Delete a Redpanda Connect MCP server
5721+
summary: Delete an MCP server
57205722
tags:
5721-
- Redpanda Connect MCP servers
5723+
- Remote MCP
57225724
get:
5723-
description: Get a specific Redpanda Connect MCP server.
5725+
description: Get a specific MCP server.
57245726
operationId: MCPServerService_GetMCPServer
57255727
parameters:
57265728
- description: MCP server ID.
@@ -5760,22 +5762,20 @@ paths:
57605762
schema:
57615763
$ref: '#/components/schemas/rpc.Status'
57625764
description: An unexpected error response.
5763-
summary: Get Redpanda Connect MCP server
5765+
summary: Get MCP server
57645766
tags:
5765-
- Redpanda Connect MCP servers
5767+
- Remote MCP
57665768
put:
5767-
description: Update the configuration of a Redpanda Connect MCP server.
5769+
description: Update the configuration of an MCP server.
57685770
operationId: MCPServerService_UpdateMCPServer
57695771
parameters:
5770-
- description: MCP Server ID.
5772+
- description: MCP server ID.
57715773
in: path
57725774
name: id
57735775
required: true
57745776
schema:
57755777
type: string
5776-
- description: |-
5777-
Specifies which fields should be updated. If not provided,
5778-
all fields will be updated.
5778+
- description: Specifies which fields to update. If not provided, updates all fields.
57795779
in: query
57805780
name: update_mask
57815781
schema:
@@ -5812,15 +5812,15 @@ paths:
58125812
schema:
58135813
$ref: '#/components/schemas/rpc.Status'
58145814
description: An unexpected error response.
5815-
summary: Update a Redpanda Connect MCP Server
5815+
summary: Update an MCP server
58165816
tags:
5817-
- Redpanda Connect MCP servers
5817+
- Remote MCP
58185818
/v1/redpanda-connect/mcp-servers/{id}:start:
58195819
post:
5820-
description: Start a stopped Redpanda Connect MCP server.
5820+
description: Start a stopped MCP server.
58215821
operationId: MCPServerService_StartMCPServer
58225822
parameters:
5823-
- description: MCP Server ID.
5823+
- description: MCP server ID.
58245824
in: path
58255825
name: id
58265826
required: true
@@ -5857,15 +5857,15 @@ paths:
58575857
schema:
58585858
$ref: '#/components/schemas/rpc.Status'
58595859
description: An unexpected error response.
5860-
summary: Start a Redpanda Connect MCP server
5860+
summary: Start an MCP server
58615861
tags:
5862-
- Redpanda Connect MCP servers
5862+
- Remote MCP
58635863
/v1/redpanda-connect/mcp-servers/{id}:stop:
58645864
post:
5865-
description: Stop a running Redpanda Connect MCP server.
5865+
description: Stop a running MCP server.
58665866
operationId: MCPServerService_StopMCPServer
58675867
parameters:
5868-
- description: MCP Server ID.
5868+
- description: MCP server ID.
58695869
in: path
58705870
name: id
58715871
required: true
@@ -5902,12 +5902,12 @@ paths:
59025902
schema:
59035903
$ref: '#/components/schemas/rpc.Status'
59045904
description: An unexpected error response.
5905-
summary: Stops a Redpanda Connect MCP server
5905+
summary: Stop an MCP server
59065906
tags:
5907-
- Redpanda Connect MCP servers
5907+
- Remote MCP
59085908
/v1/redpanda-connect/mcp-servers:getConfigSchema:
59095909
get:
5910-
description: The configuration schema includes available components and processors in this Redpanda Connect MCP Server instance.
5910+
description: Returns the configuration schema for MCP server tools, including available components and processors.
59115911
operationId: MCPServerService_GetMCPServerServiceConfigSchema
59125912
responses:
59135913
"200":
@@ -5934,12 +5934,12 @@ paths:
59345934
schema:
59355935
$ref: '#/components/schemas/rpc.Status'
59365936
description: An unexpected error response.
5937-
summary: Retrieve the schema for Redpanda Connect MCP Servers configurations.
5937+
summary: Get MCP server configuration schema
59385938
tags:
5939-
- Redpanda Connect MCP servers
5939+
- Remote MCP
59405940
/v1/redpanda-connect/mcp-servers:lint-config:
59415941
post:
5942-
description: Validates a supplied Redpanda Connect MCP tools YAML and returns a list of linting hints. If no problems are found, the list is empty.
5942+
description: Validates a given MCP tool's configuration and returns linting hints. Each tool's YAML configuration is validated. If no problems are found, the response is empty.
59435943
operationId: MCPServerService_LintMCPConfig
59445944
requestBody:
59455945
content:
@@ -5973,9 +5973,9 @@ paths:
59735973
schema:
59745974
$ref: '#/components/schemas/rpc.Status'
59755975
description: An unexpected error response.
5976-
summary: Lint a Redpanda Connect MCP tools configuration
5976+
summary: Lint a MCP tools configuration
59775977
tags:
5978-
- Redpanda Connect MCP servers
5978+
- Remote MCP
59795979
/v1/redpanda-connect/pipelines:
59805980
get:
59815981
description: 'List Redpanda Connect pipelines. Optional: filter based on pipeline name.'
@@ -8248,8 +8248,8 @@ tags:
82488248
name: Kafka Connect
82498249
- description: Create and manage [Redpanda Connect](https://docs.redpanda.com/redpanda-cloud/develop/connect/about) pipelines and their configurations.
82508250
name: Redpanda Connect Pipelines
8251-
- description: Create and manage Redpanda Connect MCP servers and their configurations.
8252-
name: Redpanda Connect MCP servers
8251+
- description: Create and manage MCP servers and their configurations.
8252+
name: Remote MCP
82538253
- description: Monitoring operations for Redpanda.
82548254
name: Monitoring
82558255
- description: Manage client throughput limits. See [Redpanda Client Throughput Limits](https://docs.redpanda.com/current/manage/cluster-maintenance/manage-throughput/#client-throughput-limits) for more information.

0 commit comments

Comments
 (0)