AgentUI Documentation
AgentUI turns MCP tools, OpenAPI operations, JSON Schemas, webhook payloads, prompts, workflow outputs, and PlatPhorm service evidence into usable forms, workflows, dashboards, approvals, reports, and shareable artifacts.
What AgentUI Does
Quick Start
- 1. Open Builder and choose a builder mode.
- 2. Render an MCP tool, OpenAPI operation, JSON Schema, or webhook payload into a form.
- 3. Validate the draft and classify public-safe versus protected steps.
- 4. Save a browser-local draft, export JSON/YAML, copy a share packet, or delegate to the right PlatPhorm service.
- 5. Use
PLATPHORM_API_KEYonly when protected server persistence, execution, publishing, or private export is required.
Guides
Getting Started
Create a local artifact, render a schema, validate it, and decide whether to export, share, or delegate.
Storage Modes
How AgentUI labels local, server, delegated, exported, generated, and degraded artifacts.
Artifact Model
The shared AgentUI artifact shape used for forms, workflows, dashboards, reports, panels, CLI recipes, IDE configs, and share packets.
MCP Tool Rendering
Convert MCP input schemas into forms with validation, JSON preview, JSON-RPC examples, and protected action panels.
OpenAPI Rendering
Turn OpenAPI operations into request forms and reproducible request examples.
JSON Schema Rendering
Render direct JSON Schema input as a form or raw JSON panel.
Webhook Rendering
Render webhook payload contracts as forms without faking deliveries.
Workflow Builder
Build workflow graphs with public/protected classification, validation, dry-run plans, and export/delegation options.
Layout And ASCII Integrations
Use Layout and ASCII as first-class AgentUI integrations without rebranding AgentUI as either service.
Block I/O Inspector
Inspect exact selected-block inputs and outputs across local previews, dry-runs, delegated runs, protected runs, and degraded states.
Templates
Use PlatPhorm-native templates for MCP forms, OpenAPI forms, protected panels, BrowserOps, Evals, Sandbox, Docs, Sheets, Trace, and CLI recipes.
Delegation
Send an artifact packet to the correct PlatPhorm service when AgentUI cannot persist or execute locally.
Sharing And Reuse
Clone, export, packetize, and rebind AgentUI artifacts.
CLI
Reproduce AgentUI inspections, renders, delegations, dry-runs, and validation harnesses with platphormctl.
IDE
Configure IDE and agent clients to use AgentUI public docs, OpenAPI, MCP, and artifact packets.
API Reference
AgentUI exposes standard PlatPhorm health, discovery, render, artifact, workflow, delegation, storage, integration, and MCP routes.
MCP Reference
AgentUI is an MCP-capable UI renderer and artifact builder.
Integrations
AgentUI integrates with PlatPhorm services as targets, sources, validators, and evidence systems without taking over their identities.