Skip to content
DreamUI Connectors
Get started

Reference

Live

API reference

The DreamUI connector exposes 29 MCP tools over stdio. Harnesses discover them at runtime with tools/list and call them with tools/call.

Discovery

Call MCP tools/list to get every tool with its current input schema. The schema returned at runtime is authoritative — tool names, accepted agent values, and optional fields come from it.

Core tools

Core DreamUI MCP tools
ToolPurpose
uicopilot_authSign the host in with device login. Actions: status, start, poll.
uicopilot_agent_runGenerate or edit a website or interface from a prompt.
uicopilot_sessions_listList the managed DreamUI sessions available to the signed-in user.
uicopilot_commandsInspect a dispatched command and its current status.
uicopilot_session_snapshotFetch the latest state of a session.

Arguments and examples for generation and sessions are in MCP adapter; auth actions are in Device login.

HTTP endpoints

Base URL https://dreamui.com. The adapter calls these for sign-in; most integrations never need to call them directly.

Device-login HTTP endpoints
EndpointUse
POST /api/cli/auth/startBegin device login. Returns deviceCode, userCode, expiresIn, loginUrl.
POST /api/cli/auth/pollExchange a device code. Returns pending, or claimed with a token.
GET /api/cli/auth/statusCheck a CLI token. Returns { ok: true } or 401.