Skip to content

Commit da9f5cc

Browse files
kbatuigasJakeSCahill
kbatuigas
and
JakeSCahill
authored
Apply suggestions from code review
Co-authored-by: Jake Cahill <[email protected]>
1 parent 5ba6b4d commit da9f5cc

File tree

2 files changed

+51
-48
lines changed

2 files changed

+51
-48
lines changed

‎cloud-controlplane/cloud-controlplane.yaml‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4857,7 +4857,7 @@ paths:
48574857
- Clusters
48584858
/v1/network/{network_id}/network-peerings:
48594859
get:
4860-
description: List Redpanda networks peerings.
4860+
description: List Redpanda network peerings.
48614861
operationId: NetworkPeeringService_ListNetworkPeerings
48624862
parameters:
48634863
- in: path
@@ -4974,7 +4974,7 @@ paths:
49744974
- Network Peerings
49754975
/v1/network/{network_peering.network_id}/network-peerings:
49764976
post:
4977-
description: Create a Redpanda network pering.
4977+
description: Create a Redpanda network peering.
49784978
operationId: NetworkPeeringService_CreateNetworkPeering
49794979
parameters:
49804980
- in: path
@@ -7294,7 +7294,6 @@ tags:
72947294
name: Serverless Private Links
72957295
- description: See available Redpanda Serverless regions.
72967296
name: Serverless Regions
7297-
- name: ShadowLinkService
72987297
- description: See information about the organization the current user belongs to.
72997298
name: Organization
73007299
- description: Manage your Redpanda Cloud organization permissions.

‎cloud-dataplane/cloud-dataplane.yaml‎

Lines changed: 49 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -506,7 +506,7 @@ components:
506506
info:
507507
$ref: '#/components/schemas/ConnectCluster.Info'
508508
name:
509-
description: Unique name of connect cluster. For Redpanda Cloud, the value is `redpanda`.
509+
description: Unique name of Connect cluster. For Redpanda Cloud, the value is `redpanda`.
510510
type: string
511511
plugins:
512512
items:
@@ -1475,7 +1475,7 @@ components:
14751475
tools:
14761476
additionalProperties:
14771477
$ref: '#/components/schemas/Tool'
1478-
description: The Redpanda Connect MCP tools configuration in YAML format.
1478+
description: The MCP tool's configuration in YAML format.
14791479
type: object
14801480
required:
14811481
- tools
@@ -1628,15 +1628,15 @@ components:
16281628
ListMCPServersRequest.Filter:
16291629
properties:
16301630
display_name_contains:
1631-
description: Any MCP Server that partially match this name will be returned.
1631+
description: Filter MCP servers by display name. Any MCP servers that partially match this name are returned.
16321632
type: string
16331633
secret_id:
1634-
description: Match MCP servers that use this secret ID.
1634+
description: Filter MCP servers by secret ID.
16351635
type: string
16361636
tags[string]:
16371637
additionalProperties:
16381638
type: string
1639-
description: MCP servers that match all the provided tags will be returned.
1639+
description: Filter MCP servers by tags. MCP servers that match all the provided tags are returned. The query format is "filter.tags[key]=value".
16401640
type: object
16411641
type: object
16421642
ListMCPServersResponse:
@@ -1646,6 +1646,7 @@ components:
16461646
$ref: '#/components/schemas/MCPServer'
16471647
type: array
16481648
next_page_token:
1649+
description: Token to retrieve the next page of results. Include this value in the next request's `page_token` parameter. Empty if there are no more results.
16491650
type: string
16501651
type: object
16511652
ListMountTasksResponse:
@@ -1958,7 +1959,7 @@ components:
19581959
tools:
19591960
additionalProperties:
19601961
$ref: '#/components/schemas/Tool'
1961-
description: The Redpanda Connect MCP server configuration.
1962+
description: The MCP server configuration.
19621963
type: object
19631964
url:
19641965
readOnly: true
@@ -1971,10 +1972,13 @@ components:
19711972
- service_account
19721973
type: object
19731974
MCPServer.ServiceAccount:
1975+
description: Service account credentials used to authenticate with Redpanda Cloud.
19741976
properties:
19751977
client_id:
1978+
description: The service account client ID for authenticating with Redpanda Cloud.
19761979
type: string
19771980
client_secret:
1981+
description: The service account client secret for authenticating with Redpanda Cloud.
19781982
type: string
19791983
required:
19801984
- client_id
@@ -2023,7 +2027,7 @@ components:
20232027
tools:
20242028
additionalProperties:
20252029
$ref: '#/components/schemas/Tool'
2026-
description: The Redpanda Connect MCP server configuration.
2030+
description: The MCP server configuration.
20272031
type: object
20282032
required:
20292033
- display_name
@@ -2036,7 +2040,7 @@ components:
20362040
description: MCP server description.
20372041
type: string
20382042
display_name:
2039-
description: User-friendly MCP servers name.
2043+
description: User-friendly MCP server name.
20402044
type: string
20412045
resources:
20422046
$ref: '#/components/schemas/Resources'
@@ -2052,7 +2056,7 @@ components:
20522056
tools:
20532057
additionalProperties:
20542058
$ref: '#/components/schemas/Tool'
2055-
description: The Redpanda Connect MCP server configuration.
2059+
description: The MCP server configuration.
20562060
type: object
20572061
type: object
20582062
MatchingACL:
@@ -4910,7 +4914,7 @@ paths:
49104914
description: 'List Kafka Connect cluster secrets. Optional: filter based on secret name and labels.'
49114915
operationId: SecretService_ListKafkaConnectSecrets
49124916
parameters:
4913-
- description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`.
4917+
- description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`.
49144918
in: path
49154919
name: cluster_name
49164920
required: true
@@ -5030,7 +5034,7 @@ paths:
50305034
description: Delete a Kafka Connect cluster secret.
50315035
operationId: SecretService_DeleteKafkaConnectSecret
50325036
parameters:
5033-
- description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`.
5037+
- description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`.
50345038
in: path
50355039
name: cluster_name
50365040
required: true
@@ -5569,20 +5573,20 @@ paths:
55695573
- Redpanda Connect Pipelines
55705574
/v1/redpanda-connect/mcp-servers:
55715575
get:
5572-
description: 'List Redpanda Connect MCP Servers. Optional: filter based on MCP server name.'
5576+
description: 'List MCP servers and optionally filter by display name, tags, or secret ID.'
55735577
operationId: MCPServerService_ListMCPServers
55745578
parameters:
5575-
- description: Any MCP Server that partially match this name will be returned.
5579+
- description: Filter MCP servers by name. Any servers that partially match this name are returned.
55765580
in: query
55775581
name: filter.display_name_contains
55785582
schema:
55795583
type: string
5580-
- description: This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18
5584+
- description: Filter MCP servers by tags. MCP servers that match all the provided tags are returned. The query format is "filter.tags[key]=value".
55815585
in: query
55825586
name: filter.tags[string]
55835587
schema:
55845588
type: string
5585-
- description: Match MCP servers that use this secret ID.
5589+
- description: Filter MCP servers by secret ID.
55865590
in: query
55875591
name: filter.secret_id
55885592
schema:
@@ -5625,11 +5629,11 @@ paths:
56255629
schema:
56265630
$ref: '#/components/schemas/rpc.Status'
56275631
description: An unexpected error response.
5628-
summary: List Redpanda Connect MCP Servers
5632+
summary: List MCP servers
56295633
tags:
56305634
- Redpanda Connect MCP servers
56315635
post:
5632-
description: Create a new Redpanda Connect MCP Server.
5636+
description: Create an MCP server.
56335637
operationId: MCPServerService_CreateMCPServer
56345638
requestBody:
56355639
content:
@@ -5663,15 +5667,15 @@ paths:
56635667
schema:
56645668
$ref: '#/components/schemas/rpc.Status'
56655669
description: An unexpected error response.
5666-
summary: Create Redpanda Connect MCP Server
5670+
summary: Create an MCP server
56675671
tags:
5668-
- Redpanda Connect MCP servers
5672+
- Remote MCP
56695673
/v1/redpanda-connect/mcp-servers/{id}:
56705674
delete:
5671-
description: Delete a Redpanda Connect MCP server.
5675+
description: Delete an MCP server.
56725676
operationId: MCPServerService_DeleteMCPServer
56735677
parameters:
5674-
- description: MCP Server ID.
5678+
- description: MCP server ID.
56755679
in: path
56765680
name: id
56775681
required: true
@@ -5707,11 +5711,11 @@ paths:
57075711
schema:
57085712
$ref: '#/components/schemas/rpc.Status'
57095713
description: An unexpected error response.
5710-
summary: Delete a Redpanda Connect MCP server
5714+
summary: Delete an MCP server
57115715
tags:
5712-
- Redpanda Connect MCP servers
5716+
- Remote MCP
57135717
get:
5714-
description: Get a specific Redpanda Connect MCP server.
5718+
description: Get a specific MCP server.
57155719
operationId: MCPServerService_GetMCPServer
57165720
parameters:
57175721
- description: MCP server ID.
@@ -5751,11 +5755,11 @@ paths:
57515755
schema:
57525756
$ref: '#/components/schemas/rpc.Status'
57535757
description: An unexpected error response.
5754-
summary: Get Redpanda Connect MCP server
5758+
summary: Get an MCP server
57555759
tags:
5756-
- Redpanda Connect MCP servers
5760+
- Remote MCP
57575761
put:
5758-
description: Update the configuration of a Redpanda Connect MCP server.
5762+
description: Edit an MCP server.
57595763
operationId: MCPServerService_UpdateMCPServer
57605764
parameters:
57615765
- description: MCP Server ID.
@@ -5803,15 +5807,15 @@ paths:
58035807
schema:
58045808
$ref: '#/components/schemas/rpc.Status'
58055809
description: An unexpected error response.
5806-
summary: Update a Redpanda Connect MCP Server
5810+
summary: Edit an MCP Server
58075811
tags:
5808-
- Redpanda Connect MCP servers
5812+
- Remote MCP
58095813
/v1/redpanda-connect/mcp-servers/{id}:start:
58105814
post:
5811-
description: Start a stopped Redpanda Connect MCP server.
5815+
description: Start an existing MCP server.
58125816
operationId: MCPServerService_StartMCPServer
58135817
parameters:
5814-
- description: MCP Server ID.
5818+
- description: MCP server ID.
58155819
in: path
58165820
name: id
58175821
required: true
@@ -5848,12 +5852,12 @@ paths:
58485852
schema:
58495853
$ref: '#/components/schemas/rpc.Status'
58505854
description: An unexpected error response.
5851-
summary: Start a Redpanda Connect MCP server
5855+
summary: Start an existing MCP server
58525856
tags:
5853-
- Redpanda Connect MCP servers
5857+
- Remote MCP
58545858
/v1/redpanda-connect/mcp-servers/{id}:stop:
58555859
post:
5856-
description: Stop a running Redpanda Connect MCP server.
5860+
description: Stop an MCP server.
58575861
operationId: MCPServerService_StopMCPServer
58585862
parameters:
58595863
- description: MCP Server ID.
@@ -5893,12 +5897,12 @@ paths:
58935897
schema:
58945898
$ref: '#/components/schemas/rpc.Status'
58955899
description: An unexpected error response.
5896-
summary: Stops a Redpanda Connect MCP server
5900+
summary: Stop an MCP server
58975901
tags:
5898-
- Redpanda Connect MCP servers
5902+
- Remote MCP
58995903
/v1/redpanda-connect/mcp-servers:getConfigSchema:
59005904
get:
5901-
description: The configuration schema includes available components and processors in this Redpanda Connect MCP Server instance.
5905+
description: The configuration schema includes all available Redpanda Connect components and processors in this MCP server instance.
59025906
operationId: MCPServerService_GetMCPServerServiceConfigSchema
59035907
responses:
59045908
"200":
@@ -5925,12 +5929,12 @@ paths:
59255929
schema:
59265930
$ref: '#/components/schemas/rpc.Status'
59275931
description: An unexpected error response.
5928-
summary: Retrieve the schema for Redpanda Connect MCP Servers configurations.
5932+
summary: Retrieve the schema for MCP server configurations
59295933
tags:
5930-
- Redpanda Connect MCP servers
5934+
- Remote MCP
59315935
/v1/redpanda-connect/mcp-servers:lint-config:
59325936
post:
5933-
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.
5937+
description: Validates a given MCP tool configuration and returns a list of linting hints. The request should contain a map of tool names to tool configurations, where each tool contains YAML in its `config_yaml` field. If no problems are found, the list is empty.
59345938
operationId: MCPServerService_LintMCPConfig
59355939
requestBody:
59365940
content:
@@ -5964,9 +5968,9 @@ paths:
59645968
schema:
59655969
$ref: '#/components/schemas/rpc.Status'
59665970
description: An unexpected error response.
5967-
summary: Lint a Redpanda Connect MCP tools configuration
5971+
summary: Lint the configuration of an MCP tool
59685972
tags:
5969-
- Redpanda Connect MCP servers
5973+
- Remote MCP
59705974
/v1/redpanda-connect/pipelines:
59715975
get:
59725976
description: 'List Redpanda Connect pipelines. Optional: filter based on pipeline name.'
@@ -7618,7 +7622,7 @@ paths:
76187622
schema:
76197623
$ref: '#/components/schemas/TransformMetadata'
76207624
description: Created
7621-
summary: Deploy Transform
7625+
summary: Deploy transform
76227626
tags:
76237627
- Wasm Transforms
76247628
/v1/transforms/{name}:
@@ -8018,8 +8022,8 @@ tags:
80188022
name: Kafka Connect
80198023
- description: Create and manage [Redpanda Connect](https://docs.redpanda.com/redpanda-cloud/develop/connect/about) pipelines and their configurations.
80208024
name: Redpanda Connect Pipelines
8021-
- description: Create and manage Redpanda Connect MCP servers and their configurations.
8022-
name: Redpanda Connect MCP servers
8025+
- description: Create and manage MCP servers and their configurations.
8026+
name: Remote MCP
80238027
- description: Monitoring operations for Redpanda.
80248028
name: Monitoring
80258029
- 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)