You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/mcp-servers.mdx
+23-21Lines changed: 23 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,16 +36,18 @@ For the best experience, configure **both** the Control Plane and Observability
36
36
37
37
### Control Plane MCP Server
38
38
39
-
The Control Plane MCP server provides **77 canonical tools** organized into six toolsets, plus 27 deprecated cluster-prefixed aliases that remain listed for one release (see [Deprecated cluster-prefixed tools](#deprecated-cluster-prefixed-tools)).
39
+
The Control Plane MCP server is organized into six toolsets.
40
+
41
+
Note: On v1.1 onwards, the cluster-prefixed tools are deprecated and remain listed until v1.2 release (see [Deprecated cluster-prefixed tools](#deprecated-cluster-prefixed-tools)).
40
42
41
43
:::info Tools in multiple toolsets
42
-
Some read-only tools (marked with †) appear in both the default developer toolsets and the PE toolset. This allows platform engineers to use the PE toolset alongside Namespace and Project toolsets without needing to enable all developer toolsets. The per-toolset counts below sum to 117 (7 + 3 + 22 + 9 + 12 + 64); subtracting the 13 †-marked cross-toolset duplicates leaves 104 listed tools in this release — 77 canonical tools plus 27 deprecated cluster-prefixed aliases. From v1.2.0 onward the aliases are hidden by default, leaving 77 listed.
44
+
Some read-only tools (marked with †) appear in both the default developer toolsets and the PE toolset. This allows platform engineers to use the PE toolset alongside Namespace and Project toolsets without needing to enable all developer toolsets.
43
45
:::
44
46
45
47
#### Deprecated cluster-prefixed tools
46
48
47
49
:::warning Deprecation notice
48
-
The 27 `*_cluster_*` tools (cluster-scoped component types, traits, workflows, and planes) are **deprecated**. Each one has been collapsed into its namespace-scoped counterpart, which now accepts a `scope: "namespace" | "cluster"` argument (defaults to `"namespace"`). For example, `get_cluster_component_type` is replaced by `get_component_type` called with `scope: "cluster"`.
50
+
The `*_cluster_*` tools (cluster-scoped component types, traits, workflows, and planes) are **deprecated**. Each one has been collapsed into its namespace-scoped counterpart, which now accepts a `scope: "namespace" | "cluster"` argument (defaults to `"namespace"`). For example, `get_cluster_component_type` is replaced by `get_component_type` called with `scope: "cluster"`.
49
51
50
52
**Rollout timeline:**
51
53
@@ -61,7 +63,7 @@ If your integration depends on the legacy `*_cluster_*` names, migrate to the ca
The PE toolset is enabled by default. These tools are intended for platform administrators who manage infrastructure, environments, platform standards, and deployment pipelines. If you need to disable the PE toolset, see [Configuring MCP Toolsets](#configuring-mcp-toolsets).
165
167
:::
166
168
167
-
**Environment Management (4)**
169
+
**Environment Management**
168
170
169
171
-`list_environments` † — List all environments in a namespace
170
172
-`create_environment` — Create a new environment in a namespace
171
173
-`update_environment` — Update an existing environment (display name, description, production flag)
172
174
-`delete_environment` — Delete an environment from a namespace
173
175
174
-
**Deployment Pipeline Management (3)**
176
+
**Deployment Pipeline Management**
175
177
176
178
-`create_deployment_pipeline` — Create a new deployment pipeline defining environment promotion order
177
179
-`update_deployment_pipeline` — Update promotion paths and approval requirements
178
180
-`delete_deployment_pipeline` — Delete a deployment pipeline from a namespace
179
181
180
-
**Component Releases (4)**
182
+
**Component Releases**
181
183
182
184
-`list_component_releases` — List all releases (immutable snapshots at a specific build) for a component
183
185
-`create_component_release` — Create a new release from the latest build of a component
184
186
-`get_component_release` — Get detailed release info including build information, image tags, and deployment status
185
187
-`get_component_release_schema` — Get the JSON schema for a component release's configuration options
186
188
187
-
**Infrastructure — Namespace-Scoped Planes (6)**
189
+
**Infrastructure — Namespace-Scoped Planes**
188
190
189
191
-`list_dataplanes` — List all data planes (clusters where workloads execute) in a namespace
190
192
-`get_dataplane` — Get detailed data plane info including cluster details, capacity, and health
@@ -193,7 +195,7 @@ The PE toolset is enabled by default. These tools are intended for platform admi
193
195
-`list_observability_planes` — List all observability planes providing monitoring, logging, and tracing in a namespace
194
196
-`get_observability_plane` — Get detailed observability plane info including observer URL and health status
195
197
196
-
**Infrastructure — Cluster-Scoped Planes (6)**_(deprecated — use the namespace-scoped tool with `scope: "cluster"`; see [Deprecated cluster-prefixed tools](#deprecated-cluster-prefixed-tools))_
198
+
**Infrastructure — Cluster-Scoped Planes**_(deprecated — use the namespace-scoped tool with `scope: "cluster"`; see [Deprecated cluster-prefixed tools](#deprecated-cluster-prefixed-tools))_
197
199
198
200
-`list_cluster_dataplanes` — List all cluster-scoped data planes
199
201
-`get_cluster_dataplane` — Get detailed info for a cluster-scoped data plane
@@ -202,7 +204,7 @@ The PE toolset is enabled by default. These tools are intended for platform admi
202
204
-`list_cluster_observability_planes` — List all cluster-scoped observability planes
203
205
-`get_cluster_observability_plane` — Get detailed info for a cluster-scoped observability plane
-`list_component_types` † — List available component types in a namespace
208
210
-`get_component_type` — Get the full definition of a component type including its complete spec
@@ -214,7 +216,7 @@ The PE toolset is enabled by default. These tools are intended for platform admi
214
216
-`get_workflow` — Get the full definition of a workflow including its complete spec
215
217
-`get_workflow_schema` † — Get the parameter schema for a workflow template
216
218
217
-
**Platform Standards — Creation Schemas (6)**
219
+
**Platform Standards — Creation Schemas**
218
220
219
221
-`get_component_type_creation_schema` — Get the spec schema for creating a component type
220
222
-`get_cluster_component_type_creation_schema`_(deprecated — use `get_component_type_creation_schema` with `scope: "cluster"`)_ — Get the spec schema for creating a cluster-scoped component type
@@ -223,7 +225,7 @@ The PE toolset is enabled by default. These tools are intended for platform admi
223
225
-`get_workflow_creation_schema` — Get the spec schema for creating a workflow
224
226
-`get_cluster_workflow_creation_schema`_(deprecated — use `get_workflow_creation_schema` with `scope: "cluster"`)_ — Get the spec schema for creating a cluster-scoped workflow
-`create_component_type` — Create a new component type in a namespace
229
231
-`update_component_type` — Update an existing component type (full replacement)
@@ -235,7 +237,7 @@ The PE toolset is enabled by default. These tools are intended for platform admi
235
237
-`update_workflow` — Update an existing workflow (full replacement)
236
238
-`delete_workflow` — Delete a workflow from a namespace
237
239
238
-
**Platform Standards — Read, Cluster-Scoped (6)**_(deprecated — use the namespace-scoped tool with `scope: "cluster"`; see [Deprecated cluster-prefixed tools](#deprecated-cluster-prefixed-tools))_
240
+
**Platform Standards — Read, Cluster-Scoped**_(deprecated — use the namespace-scoped tool with `scope: "cluster"`; see [Deprecated cluster-prefixed tools](#deprecated-cluster-prefixed-tools))_
239
241
240
242
-`list_cluster_component_types` † — List cluster-scoped component types
241
243
-`get_cluster_component_type` † — Get the full definition of a cluster-scoped component type
@@ -244,7 +246,7 @@ The PE toolset is enabled by default. These tools are intended for platform admi
244
246
-`get_cluster_trait` † — Get the full definition of a cluster-scoped trait
245
247
-`get_cluster_trait_schema` † — Get the schema for a cluster-scoped trait
246
248
247
-
**Platform Standards — Write, Cluster-Scoped (9)**_(deprecated — use the namespace-scoped tool with `scope: "cluster"`; see [Deprecated cluster-prefixed tools](#deprecated-cluster-prefixed-tools))_
249
+
**Platform Standards — Write, Cluster-Scoped**_(deprecated — use the namespace-scoped tool with `scope: "cluster"`; see [Deprecated cluster-prefixed tools](#deprecated-cluster-prefixed-tools))_
248
250
249
251
-`create_cluster_component_type` — Create a new cluster-scoped component type
250
252
-`update_cluster_component_type` — Update an existing cluster-scoped component type (full replacement)
@@ -256,7 +258,7 @@ The PE toolset is enabled by default. These tools are intended for platform admi
256
258
-`update_cluster_workflow` — Update an existing cluster-scoped workflow (full replacement)
257
259
-`delete_cluster_workflow` — Delete a cluster-scoped workflow
258
260
259
-
**Diagnostics (2)**
261
+
**Diagnostics**
260
262
261
263
-`get_resource_events` — Get Kubernetes events for a specific resource in a deployment (scheduling, startup issues)
262
264
-`get_resource_logs` — Get container logs from a specific pod in a deployment (application errors, runtime issues)
@@ -265,7 +267,7 @@ The PE toolset is enabled by default. These tools are intended for platform admi
265
267
266
268
### Observability Plane MCP Server
267
269
268
-
The Observability Plane MCP server provides **9 tools** covering logs, traces, metrics, alerts, and incidents:
270
+
The Observability Plane MCP server provides tools covering logs, traces, metrics, alerts, and incidents:
269
271
270
272
-`query_component_logs` — Query runtime application logs for components (services, APIs, workers, scheduled tasks); filter by project, component, environment, time range, log levels, and search phrases
271
273
-`query_workflow_logs` — Query CI/CD workflow run logs capturing build, test, and deployment pipeline execution details; filter by workflow run name and task name
0 commit comments