Skip to content

Update docs to match Package 2 engineering progress#29

Merged
micheleRP merged 3 commits into
mainfrom
adp-package-2-briefing-doc-catchup
May 24, 2026
Merged

Update docs to match Package 2 engineering progress#29
micheleRP merged 3 commits into
mainfrom
adp-package-2-briefing-doc-catchup

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented May 24, 2026

Summary

Brings ADP docs in line with the Package 2 briefing (May 22, 2026) across five shipped or in-production features. The benchmark verification plan that drove these changes is included at package-2-doc-verification-plan.md so we can reuse it when the briefing next gets updated.

Changes by feature

LLM Proxy (modules/ai-gateway/pages/configure-provider.adoc)

  • New Configure transcript logging section covering the per-provider toggle, the sensitive-provider pattern, and what telemetry continues to flow when capture is off.
  • Clarifies that Redpanda maintains the available-models catalog and adds upstream releases within a day or two; admins still tick to enable.

Claude Code integration (modules/integrations/pages/claude-code.adoc)

  • Replaces the // TODO stub with a full page: when-to-use, get the proxy URL, two configuration tabs (OIDC service account / Anthropic Auth passthrough), attach ADP-hosted MCP servers, verify, troubleshoot.

Managed MCP (modules/mcp/pages/create-server.adoc, modules/ai-gateway/pages/connect-agent.adoc)

  • Surfaces the Connection tab on the MCP server detail page in the Save and verify list.
  • Adds an explicit [[authenticate-with-oidc-client-credentials]] anchor in connect-agent.adoc so other pages can xref it reliably.

Cost Tracking (modules/governance/pages/budgets.adoc, modules/governance/pages/dashboard/overview.adoc)

  • New Query spend programmatically section in budgets.adoc with OIDC auth, the SpendingFilter request shape, group_by values, and worked cURL + Python examples.
  • TODO comment in dashboard/overview.adoc listing the five surfaces engineering needs to confirm as shipped today vs. coming Jun 15 (per-user filter, Top users panel, Agents drill-down, per-agent grouping, Cost & Usage user filter).

MCP OAuth Clients (modules/integrations/pages/remote-mcp-clients.adoc)

  • New No Dynamic Client Registration (RFC 7591) entry in the Limitations section so readers understand why every MCP client must be registered up-front.
  • Adds Microsoft Copilot Studio to the supported chat clients list (TODO-marked pending an end-to-end verification with engineering).

Out of scope

The Microsoft Teams integration from the briefing (95%+ shipped) is deliberately not in this PR. Engineering verification of labels, auth model, and v1/v2 messaging is pending; see package-2-doc-verification-plan.md Section 3 for the recommended approach.

Open questions for engineering

Each item below is also flagged as a // TODO comment in the relevant file.

  • LLM Proxy — transcript logging. Exact UI field label, default state, and whether disabling capture suppresses gen_ai.prompt.* and gen_ai.completion.* OTel attributes only or also touches token-count attributes.
  • Managed MCP — detail-page tabs. Confirm the tab name (Connection vs. URL-on-Overview) for managed and remote/proxied servers.
  • Cost Tracking — dashboard. Reconcile which of the five surfaces are live in Package 2 today vs. coming Jun 15 (per-user filter on chart, Top users + heatmap, Agents drill-down, per-agent grouping on GetSpendingBreakdown, per-user filter on Cost & Usage).
  • Cost Tracking — spending API. Canonical endpoint shape (Connect-Go / gRPC / JSON transcoding), method names for GetSpendingTimeSeries / GetSpendingSummary / ListSpendingEvents against the actual proto, whether the proto-generated client is recommended over raw HTTPS, OIDC-claim population of user_id and organization_id, multi-tenant scope of organization_id in the public API.
  • Claude Code. Confirm the MCP server URL shape (/mcp/v1/servers/<name> is a placeholder).
  • MCP OAuth Clients — Microsoft Copilot Studio. Has Copilot Studio been exercised end-to-end against ADP? If yes, capture the Power Platform / agent designer route to Add custom connector, the redirect URIs Microsoft publishes, and any tenant-admin consent requirements.

Preview pages

Test plan

  • Antora build runs clean: cross-refs xref:ai-gateway:connect-agent.adoc#authenticate-with-oidc-client-credentials, xref:governance:permissions-reference.adoc#spending-permissions, xref:governance:dashboard/overview.adoc, xref:observability:transcripts.adoc, xref:mcp:user-delegated-oauth.adoc, xref:ai-gateway:aggregation.adoc, xref:integrations:remote-mcp-clients.adoc, and xref:agents:integration-overview.adoc all resolve.
  • Anchor [[authenticate-with-oidc-client-credentials]] in connect-agent.adoc and [[query-spend-programmatically]] in budgets.adoc render at the correct headings.
  • Internal anchor <<register-an-oauth-client-in-ai-gateway,Register an OAuth Client>> in remote-mcp-clients.adoc resolves to the heading on the same page.
  • New claude-code.adoc content renders correctly (tabs, source blocks, table).
  • No em dashes in the rendered output (the docs-team-standards plugin can re-verify locally).
  • package-2-doc-verification-plan.md at the repo root is not included in the Antora build output (lives outside modules/).

Brings ADP docs in line with the Package 2 briefing (May 22, 2026)
across five shipped or in-production features.

LLM Proxy (configure-provider.adoc)
- New "Configure transcript logging" section covering the per-provider
  toggle, the sensitive-provider pattern, and what telemetry continues
  to flow when capture is off.
- Clarify that Redpanda maintains the available-models catalog and
  adds upstream releases within a day or two; admins still tick to
  enable.

Claude Code integration (claude-code.adoc)
- Replace the TODO stub with a full page. When-to-use, get the proxy
  URL, two configuration tabs (OIDC service account / Anthropic Auth
  passthrough), attach ADP-hosted MCP servers, verify, troubleshoot.

Managed MCP (create-server.adoc, connect-agent.adoc)
- Surface the Connection tab on the MCP server detail page in the
  Save and verify list (TODO flags the exact tab naming for eng).
- Add an explicit [[authenticate-with-oidc-client-credentials]]
  anchor in connect-agent.adoc so other pages can xref it.

Cost Tracking (budgets.adoc, dashboard/overview.adoc)
- New "Query spend programmatically" section in budgets.adoc with
  OIDC auth, the SpendingFilter request shape, group_by values, and
  worked cURL + Python examples.
- TODO comment in dashboard/overview.adoc listing the five surfaces
  eng needs to confirm as shipped in Package 2 today vs. coming
  Jun 15 (per-user filter, Top users panel, Agents drill-down,
  per-agent grouping, Cost & Usage user filter).

MCP OAuth Clients (remote-mcp-clients.adoc)
- New "No Dynamic Client Registration (RFC 7591)" entry in the
  Limitations section so readers understand why every MCP client
  must be registered up-front.
- Add Microsoft Copilot Studio to the supported chat clients list
  (TODO-marked pending an end-to-end verification with eng).

Style
- Removed all em dashes from new content per docs-team-standards.
  Replacements split into semicolons, colons, parentheses, and
  sentence breaks based on construction.

PR-context doc
- Includes package-2-doc-verification-plan.md at the repo root: the
  feature-by-feature gap analysis behind these changes. Lives outside
  modules/ so Antora ignores it; kept for the next time the Package 2
  benchmark is updated.

Microsoft Teams integration from the briefing (95%+ shipped) is
deliberately not in this PR. Eng verification of labels, auth model,
and v1/v2 messaging is pending; see plan Section 3 for the recommended
approach.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@micheleRP micheleRP requested a review from a team as a code owner May 24, 2026 16:18
@netlify
Copy link
Copy Markdown

netlify Bot commented May 24, 2026

Deploy Preview for redpanda-agentic-data-plane ready!

Name Link
🔨 Latest commit c93759d
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-agentic-data-plane/deploys/6a132b917f93420008a92ec8
😎 Deploy Preview https://deploy-preview-29--redpanda-agentic-data-plane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@micheleRP micheleRP merged commit bc493d8 into main May 24, 2026
4 checks passed
@micheleRP micheleRP deleted the adp-package-2-briefing-doc-catchup branch May 24, 2026 17:01
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