Skip to content

docs(mcp): enable the MCP subchart on self-managed#2541

Open
ash0ts wants to merge 1 commit intoanish/docs-mcp-server-reworkfrom
anish/docs-mcp-operator-enable
Open

docs(mcp): enable the MCP subchart on self-managed#2541
ash0ts wants to merge 1 commit intoanish/docs-mcp-server-reworkfrom
anish/docs-mcp-operator-enable

Conversation

@ash0ts
Copy link
Copy Markdown
Contributor

@ash0ts ash0ts commented Apr 24, 2026

Summary

Stacked on top of #2531 (anish/docs-mcp-server-rework). Adds one new ## Enable the MCP server section to platform/hosting/self-managed/operator.mdx so self-managed operators can turn on the mcp-server subchart shipped in operator-wandb 0.42.1.

The parent PR rewrites the end-user MCP page (platform/mcp-server.mdx) and explicitly keeps "Helm values, operator chart versions, subchart names, or cluster-admin instructions" out of scope. This PR fills that gap on the operator side only.

What this adds

A single section between ### Verify the installation and ## Environment-specific considerations, with:

  • Overview: what the subchart is, what <global.host>/mcp exposes, and a pointer to /platform/mcp-server for client setup.
  • Prerequisites: chart 0.42.1+, weave-trace.install: true (hard fail-guard in the chart), ingress reachable at global.host, node headroom for default resource requests (500m CPU / 1Gi memory).
  • Enable: minimal YAML patch for the existing WeightsAndBiases CR.
  • Verify: in-cluster port-forward check against /mcp/health plus the same check through the ingress.
  • Connect a client: one-line hand-off to /platform/mcp-server.
  • Troubleshooting: 4-row table covering the weave-trace fail-guard, pod Pending due to resource requests, ingress 404 on /mcp, and image pull failures in air-gapped / mirrored clusters.

What this deliberately omits

  • No Datadog / OpenTelemetry setup docs (the hosting section doesn't document Datadog anywhere today; adding it here would be inconsistent).
  • No image registry details, GKE HTTP LB addon / NEG troubleshooting, or Workload Identity recipes. Operators use the default image or mirror via the one-line override noted in the troubleshooting table.
  • No changes to platform/mcp-server.mdx (handled by docs(mcp): rework MCP server page for users #2531), localized fr/ja/ko copies (translation pipeline re-syncs from English), or docs.json nav (no new page).

Source references

Test plan

  • mint dev renders platform/hosting/self-managed/operator.mdx without warnings.
  • The new Enable the MCP server section appears in the right-rail TOC, between "Verify the installation" and "Environment-specific considerations".
  • Cross-links to /platform/mcp-server and /platform/hosting/self-managed/on-premises-deployments/kubernetes-airgapped resolve.
  • Anchor #enable-the-mcp-server is linkable from the parent PR's Dedicated/Self-Managed card once both merge.

Made with Cursor

Add an "Enable the MCP server" section to the operator guide so
self-managed operators can turn on the mcp-server subchart shipped in
operator-wandb 0.42.1. Covers prerequisites (chart >= 0.42.1,
weave-trace required, ingress reachable, node headroom), a minimal CR
patch, in-cluster and ingress health checks, a pointer to the
user-facing /platform/mcp-server page for client setup, and a short
troubleshooting table.

Stacked on anish/docs-mcp-server-rework (PR #2531), which is scoped to
end-user content and explicitly excludes operator-side Helm/chart
instructions.

Refs: wandb/helm-charts#571, wandb/helm-charts#590
Made-with: Cursor
@ash0ts ash0ts requested a review from a team as a code owner April 24, 2026 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant