Skip to content

Admin Portal

The Admin Portal is an interactive web dashboard for managing and monitoring the platform. Enable it with portal.enabled: true in your configuration.

portal:
  enabled: true
  title: "ACME Data Platform"
  logo: https://example.com/logo.svg
  logo_light: https://example.com/logo-for-light-bg.svg
  logo_dark: https://example.com/logo-for-dark-bg.svg

admin:
  enabled: true
  persona: admin

The portal is served at /portal/. Authentication is required — use the same credentials as the Admin API. The sidebar is divided into User pages (see User Portal) and Admin pages (described here).

Branding

Customize the sidebar title and logo via portal.title, portal.logo, portal.logo_light, and portal.logo_dark. The portal picks the theme-appropriate logo automatically:

  • Light theme: logo_lightlogo → built-in default
  • Dark theme: logo_darklogo → built-in default

The resolved logo is also used as the browser favicon. A built-in activity icon is used when no logo is configured. Logos should be square SVGs for best results.

Public Viewer Branding

Shared artifact links (the public viewer at /portal/view/{token}) display a two-zone header. The right zone shows the platform brand (portal.title and portal.logo). The left zone is an optional implementor brand for the organization deploying the platform:

portal:
  implementor:
    name: "ACME Corp"                    # Display name (left zone of public viewer header)
    logo: "https://acme.com/logo.svg"    # URL to SVG logo (fetched once at startup, max 1 MB)
    url: "https://acme.com"              # Clickable link wrapping name + logo

All three fields are optional. When omitted, the left zone is hidden and only the platform brand appears. The logo URL must point to an SVG file; it is fetched at server startup and inlined into the HTML.

Public Viewer Features

The public viewer includes:

  • Light/dark mode — Defaults to the system prefers-color-scheme setting. A toggle button in the header allows switching; the choice is persisted to localStorage.
  • Expiration notice — When the share has an expiration, a notice bar shows the relative time remaining (e.g., "This page expires in 6 hours"). Hidden when the share has no expiry or hide_expiration was set at share creation.
  • Notice text — Configurable per-share via notice_text. Defaults to "Proprietary & Confidential. Only share with authorized viewers." Set to "" to hide the notice entirely.

The hide_expiration and notice_text fields are set per-share when creating a share via the API:

{"expires_in": "24h", "hide_expiration": true, "notice_text": "Internal use only."}

Dashboard

The Dashboard is the admin home page, providing a real-time overview of platform health across configurable time ranges (1h, 6h, 24h, 7d).

DashboardDashboard

The dashboard includes:

  • System info bar — Platform name, version, transport, config mode, and enabled features (Audit, Knowledge, OAuth)
  • Summary cards — Total calls, success rate, average duration, unique users, unique tools, enrichment rate, and error count
  • Activity timeline — Tool call volume over time (green) with error overlay (red)
  • Top Tools / Top Users — Horizontal bar charts showing the most active tools and users
  • Performance — Response time percentiles (P50, P95, P99) and average response size
  • Recent Errors — Clickable error list with detail drawer
  • Knowledge Insights — Summary statistics and category breakdown with pending review queue
  • Connections — All configured toolkit connections with tool counts

Indexing

The Indexing tab of the Dashboard (alongside MCP, API Gateway, Health, and Events) is an admin-only, cross-kind view of embedding-index health for every consumer of the shared index_jobs queue (pkg/indexjobs): api-catalog operation vectors, tool descriptors, and any future consumer, which gets visibility here for free the moment it registers. Embedding work runs off the request path, so a provider outage, a model dimension mismatch, or repeated retries can silently degrade ranking=semantic/hybrid to lexical with only a log line as signal; this tab is the single place to answer whether indexing is healthy, what is covered, what failed, and why.

It is system-wide and admin-only by platform convention (operators see all indexing; it is not a per-persona capability). All data is real index_jobs and vector-table state — no mocked dimensions. The page polls every 5 seconds so it reflects work as the worker, reconciler, and reaper complete it.

The tab includes:

  • Provider health banner — The embedding provider's kind, model, and dimension, or a clear degraded state (noop / unconfigured) since a bad provider makes the whole index meaningless and pauses indexing.
  • Per-kind health cards (summary-first) — Each kind leads with one plain health verdict computed server-side: Up to date (the single resting state for a fully-indexed, quiescent, failure-free kind), Indexing… (work in flight), or Degraded (an open failure or a coverage shortfall). Equivalent states look identical: every up-to-date kind shows the same green badge and the same N / M · 100% coverage bar (api-catalog's expected comes from operation_count; tools writes its complete registered set atomically, so its indexed count is also its expected), and a recency line ("last indexed ", or "fully indexed" for a kind seeded outside the queue, never "never"). The per-unit job-state breakdown ("units by last run") is shown only when there is active work or an open failure, so an up-to-date card is not cluttered with an all-zero or stale stat row. A Re-index button re-enqueues every out-of-sync unit of the kind.
  • Throughput timeline — Completed jobs over time (d3 area), so an operator can see indexing keeping up or stalling.
  • Embed latency — Per-kind started-to-completed duration (p50 with a p95 marker), surfacing slow passes such as the CPU-only embedder case.
  • In flight — Running jobs with worker id, lease countdown, and items-done progress for long passes.
  • Retry backoff — Pending jobs that already failed once, with attempt count and next run time.
  • Failure triage (self-resolving) — Units with open failures, grouped by error signature. Each unit shows first-seen / last-seen timestamps, occurrence and attempt counts, and "last succeeded" context, with an expandable drill-in to the un-redacted error and the underlying job id. A failure auto-resolves (leaves the panel) once a later job for the same unit succeeds; Retry re-enqueues the unit and the card clears when it next succeeds, and Dismiss is the explicit fallback that resolves a failure (such as a removed consumer's leftover rows) that no future success will supersede.
  • Jobs drill-down — A filterable table (by kind and status) of recent jobs with trigger, attempts, last update, and error. Routine timer-driven reconciler successes for a unit (which every replica re-runs on its own schedule) are collapsed into a single "synced ×N" row so they do not drown the table.

The existing per-catalog embedding badges in the API Catalogs panel remain; this tab is the cross-kind superset.

Tools

Overview

The Tools Overview tab shows all configured connections and a complete tool inventory.

Tools OverviewTools Overview

Each connection card displays the toolkit type (Trino, DataHub, S3), connection name, and the tools it provides. The Tool Inventory table below lists every registered tool with its description pulled from the MCP schema, visibility status, kind, and toolkit assignment.

Explore

The Explore tab provides an interactive tool execution environment for testing and debugging.

Tools ExploreTools Explore

Features:

  • Tool browser — Tools grouped by connection (Trino, DataHub, S3) with search filtering
  • Dynamic parameter form — Auto-generated from each tool's JSON schema with type-appropriate inputs (text areas for SQL, number fields for limits, dropdowns for enums)
  • Result display — Rendered markdown tables for structured data, with a Raw toggle for JSON output
  • Semantic context — Cross-injection enrichment shown below results: dataset descriptions, owners, tags, column metadata, glossary terms, and lineage sources
  • Execution history — Timestamped log of tool calls with duration, status, and replay capability

Audit Log

Overview

The Audit Overview tab provides platform-wide analytics across configurable time ranges.

Audit OverviewAudit Overview

Includes the same summary cards, activity timeline, top tools, and top users charts as the Dashboard — focused specifically on audit data with additional performance percentiles and error tracking.

Events

The Events tab provides a searchable, filterable log of every tool call.

Audit EventsAudit Events

Features:

  • Filters — User, tool, status (success/failure), and time range dropdowns
  • Sortable columns — Timestamp, user, tool, toolkit, connection, duration, status, and enrichment
  • Export — Export CSV and Export JSON buttons
  • Event detail drawer — Click any row to open the full detail:
    • Identity — User email, persona, session ID
    • Execution — Tool name, toolkit, connection, duration
    • Status — Success/failure, enrichment status
    • Transport — HTTP or stdio, request/response sizes, content block count
    • Parameters — Full request parameters as JSON

Knowledge & Memory

Overview

The Knowledge & Memory Overview provides insight and memory statistics with distribution charts.

Knowledge OverviewKnowledge Overview

The overview includes:

  • Knowledge Capture cards — Total insights, pending review, approved, applied, rejected, and approval rate
  • Insight Status Distribution — Donut chart showing insight lifecycle states (pending, approved, applied, rejected, rolled back, superseded)
  • Memory cards — Total memories, active, stale, and dimensions count
  • Memory Status Distribution — Donut chart of memory states
  • Memory by Dimension — Distribution across LOCOMO dimensions (knowledge, event, entity, relationship, preference)

Knowledge Capture

The Knowledge Capture tab lists all captured insights with filtering and admin review actions.

Knowledge CaptureKnowledge Capture

Features:

  • Summary cards — Pending review, total insights, top category, and applied count
  • Filters — Status, category, and confidence dropdowns
  • Sortable table — Created at, captured by, category, confidence, insight text, and status
  • Status badges — Color-coded: pending (amber), approved (green), applied (green), rejected (red), rolled back (red), superseded (gray)
  • Insight detail drawer — Click any row to see full metadata, entity URNs, suggested actions, related columns, review notes, and approve/reject buttons

All Memory

The All Memory tab shows every memory record across all users and sessions.

All MemoryAll Memory

Features:

  • Summary cards — Total, active, stale, and archived counts
  • Filters — Dimension, category, status, and source dropdowns
  • Sortable table — Created, user, persona, dimension, category, content preview, status, and confidence
  • Memory detail drawer — Full content (rendered as markdown), entity URNs, metadata, stale reason, and archive action

Changesets

The Changesets tab tracks catalog changes that resulted from approved knowledge.

ChangesetsChangesets

Each changeset records what was changed, the target DataHub URN, the change type (e.g., Update Column Description), who applied it, and its status. Changesets support rollback to revert applied catalog changes.

Assets (Admin)

The admin Assets page shows all platform assets across all users with search and filtering.

Admin AssetsAdmin Assets

The table displays name, owner email, content type, file size, sharing status, and creation date. Click any asset to open the detail view:

Admin Asset DetailAdmin Asset Detail

The admin asset detail renders the asset content in a full-screen viewer with Preview/Source toggle, owner display, and management actions (Delete, Download, Share).

Resources (Admin)

The admin Resources page shows managed resources across all personas and scopes.

Admin ResourcesAdmin Resources

Features:

  • Scope tabs — All Resources, Global, and per-persona tabs (admin, data-engineer, finance-executive, etc.)
  • Search and filter — Text search and category dropdown
  • Upload button — Upload new resources scoped to any persona
  • Resource table — Name, scope badge, category, MIME type, tags, file size, uploader email, and last updated date

Prompts (Admin)

The admin Prompts page provides global prompt management across all scopes and personas.

Admin PromptsAdmin Prompts

Features:

  • Scope filter — Dropdown to filter by Global, Persona, Personal, or System scope
  • Search — Full-text search across name and description
  • New Prompt — Create prompts with scope, persona assignment, tags, and enabled/disabled state
  • Sortable table — Name, scope badge, description, owner, category, and actions
  • Scope badges — Global (blue), Persona (purple), Personal (gray), System (amber)
  • Status badges — Lifecycle state next to each name: draft (gray), approved (emerald), deprecated (amber), superseded (rose)
  • Lifecycle controls — Editing a prompt exposes a status selector to move it through draft -> approved -> deprecated/superseded; approval stamps the acting admin. Selecting superseded reveals a field to record the replacement prompt name.
  • Tags — Comma-separated labels set on create and edit, shown as chips in the expanded row

Connections

The Connections page manages toolkit backend instances (Trino, DataHub, S3, MCP gateway) using a split-pane layout.

ConnectionsConnections

Left pane — Connection list grouped by kind (DataHub, S3, Trino), with source badges (file or database), descriptions, and tool counts.

Right pane — Selected connection detail showing:

  • Metadata — Kind, created by, and last updated
  • Configuration — Key-value pairs with "Show sensitive" toggle for passwords and tokens
  • Actions — Edit and Delete buttons

Source tracking:

Badge Meaning
file Defined in the YAML config file. Read-only in the admin UI.
database Created via the admin UI. Fully editable.
both Defined in config with a database override. Database version is active.
  • File connections are read-only. Editing creates a database override (source becomes "both").
  • Deleting a "both" connection removes the override and reverts to the file version.
  • + Add Connection at the bottom creates database-only connections.

MCP Gateway Connections

Connections of kind mcp proxy upstream MCP servers and re-expose their tools as <connection_name>__<remote_tool> (e.g. vendor__list_contacts). They share the same split-pane layout as other connections; the right pane adds a row of gateway-specific actions beneath the metadata block:

Action What it does
Test connection Dials the upstream with the current form values (without saving) and reports whether tool discovery succeeded. Use to validate credentials before persisting.
Refresh tools Re-dials a saved connection and re-registers its tool catalog on the live MCP server. Use after the upstream changes its tools.
Enrichment rules Opens a side drawer for the cross-enrichment rule editor (see below).

Add MCP Connection

The + Add Connection form for kind mcp exposes:

  • Endpoint — URL of the upstream MCP server (streamable HTTP).
  • Connection name — local prefix for the proxied tools.
  • Auth modeNone / Bearer token / API key / OAuth 2.1.
  • Credential (bearer/api_key) — encrypted at rest with ENCRYPTION_KEY.
  • OAuth fields (when auth_mode=OAuth 2.1):
  • Grant typeclient_credentials (machine-to-machine) or authorization_code + PKCE (browser sign-in) for upstreams like Salesforce Hosted MCP that require human sign-in.
  • Authorization URL — appears only for authorization_code; e.g. https://login.salesforce.com/services/oauth2/authorize.
  • Token URL — OAuth token endpoint.
  • Client ID / Client Secret — from the upstream's OAuth app registration.
  • Scope — for authorization_code, include refresh_token so cron jobs and scheduled prompts survive access-token expiry.
  • Connect timeout / Call timeout — bounds the dial + tool-call durations.

After saving an authorization_code connection, the right pane shows an amber Not connected banner with a Connect button.

OAuth Connect Button

For authorization_code connections:

  1. Click Connect on the connection card.
  2. A new tab opens to the upstream's /authorize URL with PKCE state and redirect_uri=<platform-host>/api/v1/admin/oauth/callback.
  3. Operator authenticates with the upstream provider.
  4. The upstream redirects back to the platform's callback. The platform exchanges the code for tokens and stores them encrypted at rest in gateway_oauth_tokens (AES-256-GCM via ENCRYPTION_KEY).
  5. The card now shows Authorized by <email> <time ago> and the tool list populates.

The platform refreshes the access token automatically using the stored refresh token, so cron jobs and scheduled prompts run untouched until the upstream invalidates the refresh token. Click Reconnect to re-authorize manually if needed; click Refresh now to force an immediate refresh.

Cross-Enrichment Rules Drawer

Clicking Enrichment rules on a saved gateway connection opens a slide-out drawer for managing rules that join proxied tool responses with native warehouse / catalog context:

  • Rule list — one row per rule, with toggle for enable/disable, edit, delete, and Dry-run preview.
  • New rule — opens the rule editor with three structured sections:
  • Tool name (autocomplete from this connection's discovered tools).
  • When predicatealways or response_contains with JSONPath.
  • Enrich action — source (trino or datahub), operation, and parameters with JSONPath bindings ($.args, $.response, $.user).
  • Merge strategy — where the enrichment lands in the response (enrichment by default; configurable path).
  • Dry-run — paste a sample tool call, get the merged response back without executing any side effects.

Rule failures attach a warning: text content to the response and never fail the parent tool call. See Gateway Toolkit for the full rule schema.

Personas

The Personas page manages role-based tool access rules and context overrides using the same split-pane layout as Connections.

PersonasPersonas

Left pane — Persona list with display name, slug, role count, and resolved tool count.

Right pane — Selected persona detail showing:

  • Metadata — Priority, resolved tools count, and assigned roles
  • Tool Access Rules — Allow patterns (green badges, e.g., trino_*, datahub_*) and deny patterns (red badges, e.g., capture_insight)
  • Resolved Tools — Expandable list of the actual tools this persona can access
  • Context Overrides — Description prefix and agent instructions suffix that customize AI behavior for this persona

See Personas for configuration details.

API Keys

The Keys page manages API keys for programmatic authentication.

API KeysAPI Keys

Features:

  • Key table — Name, source badge (file/database), email, description, roles badge, expiration date, and actions
  • Expired keys — Shown with dimmed text and "Expired" badge
  • + Add Key — Create keys with name, email, description, roles, and expiration preset (Never, 24h, 7d, 30d, 90d, 1yr). The plaintext key is shown only once at creation.
  • Delete — Available for database-managed keys only; file keys are read-only
  • Source badges — Same file/database/both system as Connections

Change Log

The Change Log page provides an audit trail of all configuration changes made via the admin UI.

Change LogChange Log

Each entry shows:

  • Config key — The configuration path that changed (e.g., server.description, server.agent_instructions)
  • Action — Set (red badge) indicating a value was written
  • Timestamp — When the change was made

Local Development

Run the portal locally with demo data using Mock Service Worker:

cd ui
npm install
VITE_MSW=true npm run dev

Open http://localhost:5173/portal/ — no backend required. The mock data includes realistic ACME Corporation demo content with 200+ audit events, 50 knowledge insights, 6 personas, and 12 users.

For full-stack development with a real backend:

make dev-up                                        # Start PostgreSQL
go run ./cmd/mcp-data-platform --config dev/platform.yaml  # Start server
psql -h localhost -U platform -d mcp_platform -f dev/seed.sql  # Seed demo data
cd ui && npm run dev                               # Start React dev server

See dev/README.md for complete local development instructions.

Generating Screenshots

Automated screenshot generation captures every portal page in light and dark modes:

cd ui
npm run screenshots              # Generate PNG screenshots
npm run screenshots:convert      # Convert to optimized WebP

Screenshots are saved to docs/images/screenshots/light/ and docs/images/screenshots/dark/. See ui/e2e/screenshots/README.md for configuration options including custom branding.