Skip to content

Hide deprecated Remote MCP endpoints via overlay #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kbatuigas merged 2 commits into from
Jul 21, 2026
+63 −0
Merged

Hide deprecated Remote MCP endpoints via overlay #78

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
905abb2
docs(cloud-dataplane): hide deprecated Remote MCP endpoints via overlay
kbatuigas Jul 20, 2026
0c2cce6
Apply suggestion from doc review
kbatuigas Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions cloud-dataplane/overlays/hide-remote-mcp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
overlay: 1.0.0
info:
title: Hide Remote MCP endpoints
version: 1.0.0
actions:
# --- Paths (exact keys confirmed in cloud-dataplane.yaml) ---
- target: "$.paths['/v1/redpanda-connect/mcp-servers']"
remove: true
- target: "$.paths['/v1/redpanda-connect/mcp-servers/{id}']"
remove: true
- target: "$.paths['/v1/redpanda-connect/mcp-servers/{id}:start']"
remove: true
- target: "$.paths['/v1/redpanda-connect/mcp-servers/{id}:stop']"
remove: true
- target: "$.paths['/v1/redpanda-connect/mcp-servers:getConfigSchema']"
remove: true
- target: "$.paths['/v1/redpanda-connect/mcp-servers:lint-config']"
remove: true
# --- Tag definition (avoids an empty nav group) ---
- target: "$.tags[?(@.name=='Remote MCP')]"
remove: true
# --- MCP-only component schemas (all verified MCP-exclusive) ---
- target: "$.components.schemas.CreateMCPServerResponse"
remove: true
- target: "$.components.schemas.DeleteMCPServerResponse"
remove: true
- target: "$.components.schemas.GetMCPServerResponse"
remove: true
- target: "$.components.schemas.GetMCPServerServiceConfigSchemaResponse"
remove: true
- target: "$.components.schemas.LintMCPConfigRequest"
remove: true
- target: "$.components.schemas.LintMCPConfigResponse"
remove: true
- target: "$.components.schemas['ListMCPServersRequest.Filter']"
remove: true
- target: "$.components.schemas.ListMCPServersResponse"
remove: true
- target: "$.components.schemas.MCPServer"
remove: true
- target: "$.components.schemas['MCPServer.ServiceAccount']"
remove: true
- target: "$.components.schemas['MCPServer.State']"
remove: true
- target: "$.components.schemas['MCPServer.Status']"
remove: true
- target: "$.components.schemas.MCPServerCreate"
remove: true
- target: "$.components.schemas.MCPServerUpdate"
remove: true
- target: "$.components.schemas.StartMCPServerResponse"
remove: true
- target: "$.components.schemas.StopMCPServerResponse"
remove: true
- target: "$.components.schemas.UpdateMCPServerResponse"
remove: true
Comment on lines +22 to +56

@coderabbitai coderabbitai Bot Jul 20, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '\n== overlay ==\n'
cat -n cloud-dataplane/overlays/hide-remote-mcp.yaml

printf '\n== files mentioning MCP schema names ==\n'
rg -n "CreateMCPServerResponse|DeleteMCPServerResponse|GetMCPServerResponse|GetMCPServerServiceConfigSchemaResponse|LintMCPConfigRequest|LintMCPConfigResponse|ListMCPServersRequest.Filter|ListMCPServersResponse|MCPServer|MCPServerCreate|MCPServerUpdate|StartMCPServerResponse|StopMCPServerResponse|UpdateMCPServerResponse|ConfigurationYAMLSchema|ComponentType|Tool" cloud-dataplane -g '!**/*.lock'

printf '\n== nearby definitions in source spec files ==\n'
rg -n -A4 -B4 "ConfigurationYAMLSchema|ComponentType|Tool|MCPServer|LintMCPConfig|GetMCPServerServiceConfigSchemaResponse" cloud-dataplane

Repository: redpanda-data/api-docs

Length of output: 44079

🏁 Script executed:

#!/bin/bash
set -euo pipefail

python3 - <<'PY'
from pathlib import Path
import re

text = Path("cloud-dataplane/cloud-dataplane.yaml").read_text()

names = ["Tool", "ConfigurationYAMLSchema", "ComponentType"]
for name in names:
    refs = []
    for i, line in enumerate(text.splitlines(), 1):
        if f"`#/components/schemas/`{name}" in line:
            refs.append((i, line.strip()))
    print(f"\n{name}: {len(refs)} refs")
    for i, line in refs:
        print(f"  {i}: {line}")

# crude check for named schema definitions themselves
print("\nDefinitions:")
for name in names:
    m = re.search(rf"^\s*{re.escape(name)}:\s*$", text, re.M)
    print(f"  {name}: {'present' if m else 'missing'}")
PY

Repository: redpanda-data/api-docs

Length of output: 650

Remove the remaining MCP-only component schemas.

Tool, ConfigurationYAMLSchema, and ComponentType are still defined under components.schemas, and they’re only used by the MCP schemas removed above. Add them to the overlay too.

Proposed additions 
+  - target: "$.components.schemas.ConfigurationYAMLSchema"
+    remove: true
+  - target: "$.components.schemas.ComponentType"
+    remove: true
+  - target: "$.components.schemas.Tool"
+    remove: true
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# --- MCP-only component schemas (all verified MCP-exclusive) ---
- target: "$.components.schemas.CreateMCPServerResponse"
remove: true
- target: "$.components.schemas.DeleteMCPServerResponse"
remove: true
- target: "$.components.schemas.GetMCPServerResponse"
remove: true
- target: "$.components.schemas.GetMCPServerServiceConfigSchemaResponse"
remove: true
- target: "$.components.schemas.LintMCPConfigRequest"
remove: true
- target: "$.components.schemas.LintMCPConfigResponse"
remove: true
- target: "$.components.schemas['ListMCPServersRequest.Filter']"
remove: true
- target: "$.components.schemas.ListMCPServersResponse"
remove: true
- target: "$.components.schemas.MCPServer"
remove: true
- target: "$.components.schemas['MCPServer.ServiceAccount']"
remove: true
- target: "$.components.schemas['MCPServer.State']"
remove: true
- target: "$.components.schemas['MCPServer.Status']"
remove: true
- target: "$.components.schemas.MCPServerCreate"
remove: true
- target: "$.components.schemas.MCPServerUpdate"
remove: true
- target: "$.components.schemas.StartMCPServerResponse"
remove: true
- target: "$.components.schemas.StopMCPServerResponse"
remove: true
- target: "$.components.schemas.UpdateMCPServerResponse"
remove: true
# --- MCP-only component schemas (all verified MCP-exclusive) ---
- target: "$.components.schemas.CreateMCPServerResponse"
remove: true
- target: "$.components.schemas.DeleteMCPServerResponse"
remove: true
- target: "$.components.schemas.GetMCPServerResponse"
remove: true
- target: "$.components.schemas.GetMCPServerServiceConfigSchemaResponse"
remove: true
- target: "$.components.schemas.LintMCPConfigRequest"
remove: true
- target: "$.components.schemas.LintMCPConfigResponse"
remove: true
- target: "$.components.schemas['ListMCPServersRequest.Filter']"
remove: true
- target: "$.components.schemas.ListMCPServersResponse"
remove: true
- target: "$.components.schemas.MCPServer"
remove: true
- target: "$.components.schemas['MCPServer.ServiceAccount']"
remove: true
- target: "$.components.schemas['MCPServer.State']"
remove: true
- target: "$.components.schemas['MCPServer.Status']"
remove: true
- target: "$.components.schemas.MCPServerCreate"
remove: true
- target: "$.components.schemas.MCPServerUpdate"
remove: true
- target: "$.components.schemas.StartMCPServerResponse"
remove: true
- target: "$.components.schemas.StopMCPServerResponse"
remove: true
- target: "$.components.schemas.UpdateMCPServerResponse"
remove: true
- target: "$.components.schemas.ConfigurationYAMLSchema"
remove: true
- target: "$.components.schemas.ComponentType"
remove: true
- target: "$.components.schemas.Tool"
remove: true
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cloud-dataplane/overlays/hide-remote-mcp.yaml` around lines 22 - 56, Add
removal entries in the MCP-only component schema section for the remaining
schemas $.components.schemas.Tool, $.components.schemas.ConfigurationYAMLSchema,
and $.components.schemas.ComponentType, matching the existing remove directives
and preserving the overlay structure.

# --- Transitively MCP-only schemas (orphaned once the above are removed) ---
- target: "$.components.schemas.ConfigurationYAMLSchema"
remove: true
- target: "$.components.schemas.Tool"
remove: true
- target: "$.components.schemas.ComponentType"
remove: true
Loading