Skip to content

Commit dd4f79b

Browse files
committed
docs: update MCP cluster-prefixed tool deprecation notice for v1.2.0
Signed-off-by: chathuranga95 <siriwardhanachathuranga@gmail.com>
1 parent 9c1de2a commit dd4f79b

1 file changed

Lines changed: 14 additions & 20 deletions

File tree

docs/reference/mcp-servers.mdx

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For the best experience, configure **both** the Control Plane and Observability
3838

3939
The Control Plane MCP server is organized into seven toolsets.
4040

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)).
41+
Note: The cluster-prefixed tools have been deprecated since v1.1 and, as of v1.2.0, are hidden from `tools/list` by default (see [Deprecated cluster-prefixed tools](#deprecated-cluster-prefixed-tools)).
4242

4343
:::info Tools in multiple toolsets
4444
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.
@@ -51,15 +51,15 @@ The `*_cluster_*` tools (cluster-scoped component types, traits, workflows, and
5151

5252
**Rollout timeline:**
5353

54-
| Release | `tools/list` behavior | Callable? |
55-
| ----------- | --------------------------------------------------------------------------------- | --------- |
56-
| **current** | Aliases **listed by default**, each marked deprecated in its description. | Yes |
57-
| **v1.2.0** | Aliases **hidden by default**; set `?includeDeprecatedTools=true` to opt back in. | Yes |
58-
| **v1.3.0** | Aliases **removed**; the `includeDeprecatedTools` flag is also removed. | No |
54+
| Release | `tools/list` behavior | Callable? |
55+
| -------------------- | --------------------------------------------------------------------------------- | --------- |
56+
| **v1.1.x** | Aliases **listed by default**, each marked deprecated in its description. | Yes |
57+
| **current (v1.2.0)** | Aliases **hidden by default**; set `?includeDeprecatedTools=true` to opt back in. | Yes |
58+
| **v1.3.0** | Aliases **removed**; the `includeDeprecatedTools` flag is also removed. | No |
5959

6060
Every invocation of a deprecated alias returns a deprecation warning pointing to the replacement, so clients that ignore `tools/list` metadata still get a migration signal at call time.
6161

62-
If your integration depends on the legacy `*_cluster_*` names, migrate to the canonical tool with `scope: "cluster"` before v1.2.0discovery-driven clients that read `tools/list` will stop seeing the aliases on that release unless you append `?includeDeprecatedTools=true` to the MCP server URL (see [Per-Session Tool Filtering](#per-session-tool-filtering)).
62+
If your integration depends on the legacy `*_cluster_*` names, migrate to the canonical tool with `scope: "cluster"` — as of v1.2.0, discovery-driven clients that read `tools/list` no longer see the aliases unless you append `?includeDeprecatedTools=true` to the MCP server URL (see [Per-Session Tool Filtering](#per-session-tool-filtering)).
6363
:::
6464

6565
<details>
@@ -406,21 +406,15 @@ The `namespace` and `project` toolsets are useful companions for the PE toolset
406406

407407
## Per-Session Tool Filtering
408408

409-
By default, the Control Plane MCP server filters `tools/list` and `tools/call` results by the authenticated user's permissions. Tools the user lacks permission for are hidden, and unauthorized calls are rejected. MCP clients can additionally narrow what a session sees, opt out of authorization-based filtering, or opt out of the deprecated cluster-prefixed aliases early, by passing optional query parameters when establishing the session.
409+
By default, the Control Plane MCP server filters `tools/list` and `tools/call` results by the authenticated user's permissions. Tools the user lacks permission for are hidden, and unauthorized calls are rejected. MCP clients can additionally narrow what a session sees, opt out of authorization-based filtering, or opt back into the deprecated cluster-prefixed aliases, by passing optional query parameters when establishing the session.
410410

411-
| Query Parameter | Required | Default | Description |
412-
| ------------------------ | -------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
413-
| `toolsets` | `false` | All configured toolsets | Comma-separated list of toolsets to expose via `tools/list` for the session (e.g. `namespace,component,pe`). Unknown toolset names are silently ignored. |
414-
| `filterByAuthz` | `false` | `true` | When `true`, hides tools the user cannot call and rejects unauthorized invocations. Set to `false` to disable MCP-layer authorization filtering. |
415-
| `includeDeprecatedTools` | `false` | `true` (changing to `false` in v1.2.0) | Controls whether `tools/list` includes the deprecated cluster-prefixed aliases. The aliases remain callable regardless of this flag — it only controls listing. The flag and aliases are both removed in v1.3.0. |
411+
| Query Parameter | Required | Default | Description |
412+
| ------------------------ | -------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
413+
| `toolsets` | `false` | All configured toolsets | Comma-separated list of toolsets to expose via `tools/list` for the session (e.g. `namespace,component,pe`). Unknown toolset names are silently ignored. |
414+
| `filterByAuthz` | `false` | `true` | When `true`, hides tools the user cannot call and rejects unauthorized invocations. Set to `false` to disable MCP-layer authorization filtering. |
415+
| `includeDeprecatedTools` | `false` | `false` (was `true` before v1.2.0) | Controls whether `tools/list` includes the deprecated cluster-prefixed aliases. The aliases remain callable regardless of this flag — it only controls listing. The flag and aliases are both removed in v1.3.0. |
416416

417-
**Example — current release** (everything listed by default, so the flag is only needed if you want to opt out of the deprecated aliases early):
418-
419-
```
420-
http://api.openchoreo.localhost:8080/mcp?toolsets=namespace,component,pe&filterByAuthz=false&includeDeprecatedTools=false
421-
```
422-
423-
**Example — v1.2.0 and later** (deprecated aliases hidden by default; opt back in explicitly):
417+
**Example** (as of v1.2.0 the deprecated aliases are hidden by default; append `includeDeprecatedTools=true` to opt back in):
424418

425419
```
426420
http://api.openchoreo.localhost:8080/mcp?toolsets=namespace,component,pe&filterByAuthz=false&includeDeprecatedTools=true

0 commit comments

Comments
 (0)