@terreno/mcp 57.9.0 → 57.10.1

package/dist/docs/versioned/next/implementationPlans/agent-ui-asks.md

@@ -0,0 +1,688 @@
+# Agent UI Asks — agents ask the user for a typed answer inside the chat
+
+**Status:** In progress — Phases 1–2 shipped for review 2026-09-28. On 2026-10-01 this plan also owns the body-component contract (the former Agent UI Blocks IP). Pick executes Phase 5 tasks B1.1–B4.2 from [`docs/tasks/agent-ui-asks.md`](../tasks/agent-ui-asks.md). Asks Tasks 3.1 and 3.2 start after B1.1 and B2.1. The design record stays in [`agent-ui-blocks.md`](./agent-ui-blocks.md). Approved 2026-09-27 (Q1–Q12 confirmed; `assumed` rows are engineering defaults Pick may revise with a note)  
+**Roadmap:** Area=`ai`, Target=`Next`, Impact=`Feature`  
+**Branch:** `cursor/agent-ui-asks-grow-a1e2`  
+**Owner:** unassigned  
+**Created:** 2026-09-26  
+**Task list:** [`docs/tasks/agent-ui-asks.md`](../tasks/agent-ui-asks.md)  
+**Linear:** none  
+**Roadmap issue:** none yet (the roadmap-reconcile workflow scaffolds the entry from the `Roadmap:` header and opens the tracking issue when this plan merges)  
+**Related:** [`agent-ui-blocks.md`](./agent-ui-blocks.md) (display catalog, `@terreno/blocks`, [#1389](https://github.com/TerrenoLabs/terreno/issues/1389)), [`charts-and-dashboards.md`](./charts-and-dashboards.md) (chart components, [PR #1302](https://github.com/TerrenoLabs/terreno/pull/1302)), [`ai-agents-and-failover.md`](./ai-agents-and-failover.md) (defers human-in-the-loop approval), [`app-mcp-server.md`](./app-mcp-server.md) (defers MCP Apps HTML), [`infra-mcp.md`](./infra-mcp.md) (MCP elicitation precedent)  
+**Primary packages:** `@terreno/blocks` (ask schemas, validators, simple cards), `@terreno/ai` (ask tools, pause/resume, headless turn endpoints, file handling, HTML sanitizer), `@terreno/ui` (ask renderers in `GPTChat`, `SimpleAskCard`, `HtmlFrame`), `demo`, `example-frontend`, `example-backend`
+
+## Goal
+
+Let an agent **ask the user something and get a typed answer back in the same turn**. The
+agent calls an ask tool: pick one, pick many, upload images or files, edit a markdown draft,
+confirm an action, or fill a short form. `GPTChat` renders the matching `@terreno/ui`
+control inline. The user answers. The answer returns to the agent as a validated tool
+result and the turn continues from where it paused.
+
+Asks are strict. Every ask kind is a Zod `.strict()` schema with hard limits, so the model
+can only request controls the chat can render, and the user can only return values that
+ask allows. The server validates the model's ask when it is made and the user's answer
+when it arrives, with the same pure functions the client uses to enable its Submit button.
+
+Every ask also comes as a **simple card**: a short text and at most three buttons (Approve /
+Cancel, or up to three short options), each button carrying the exact answer it sends.
+The server computes it, so a client that knows nothing about ask kinds — a SwiftUI Apple
+Watch app, a notification, Wear OS, a Slack bot — can render the card and answer with one
+tap. Asks that cannot shrink (file uploads, markdown edits, long forms) say so and point
+the user to the full app. A small client can also tell the server it is small, and the
+agent then only asks button-sized questions.
+
+The plan also adds the one display element Agent UI Blocks ruled out — **sandboxed,
+display-only HTML** — and maps which other `@terreno/ui` components are worth rendering in
+a chat. Charts stay where they are already designed: Agent UI Blocks `chart` blocks on top
+of the `LineChart` / `BarChart` / `AreaChart` / `DonutChart` components that shipped in
+PR #1302.
+
+## Overlap with prior plans
+
+| Plan | Status | Already covers | This plan adds |
+| --- | --- | --- | --- |
+| [Agent UI Blocks](./agent-ui-blocks.md) | Folded into this plan 2026-10-01 (design record; execution is Phase 5 here) | Display catalog, whole-reply YAML, `BlocksView`, `GPTChat.uiBlocks`, button actions, `POST /gpt/actions` | Owned here as [body components](#body-components-agent-ui-blocks). Asks still add the answer path plus `html`, `callout`, `image`, and `details`. |
+| [Charts and dashboards](./charts-and-dashboards.md) | Chart components shipped | `LineChart`, `BarChart`, `AreaChart`, `DonutChart`, `DashboardGrid` | Nothing. Charts reach the chat through Agent UI Blocks. |
+| [AI agents and failover](./ai-agents-and-failover.md) | Draft | Server-executed tools in `Agent` | It lists human-in-the-loop approval/resume as a non-goal. Asks are that capability for chat. |
+| [App MCP server](./app-mcp-server.md) | Draft | Runtime MCP tools, prompts, resources | It defers MCP Apps (`ui://` HTML apps). This plan's HTML is display-only and does not implement MCP Apps. |
+| [Infra MCP](./infra-mcp.md) | Planned | MCP elicitation for write confirmation | Same answer envelope (`accept` / `decline` / `cancel`), different host (IDE MCP client vs `GPTChat`). |
+| [GPT chat mascot](./gpt-chat-mascot.md), [consent forms](./consent-forms.md) | Complete | Empty-chat slot; signature and markdown form UX | Nothing new; renderers reuse the same `@terreno/ui` fields. |
+| [Comms: Expo push](./comms-adapter-expo-push.md), [notification center](./notification-center.md) | Complete | Push with title, body, data, badge, sound; `notify()` fans out title and body only. Notification action buttons are an explicit non-goal. | Nothing in v1 (Q7 = A). Actionable ask notifications, which iOS forwards to Apple Watch, stay in Future Work and would extend both. |
+
+How asks and blocks divide the work:
+
+| Need | Mechanism | Owner |
+| --- | --- | --- |
+| Show data (chart, table, metric, callout, image, HTML preview) | Block in the reply document | This plan, Phase 5 (design record: Agent UI Blocks) plus `html`, `callout`, `image`, `details` (Tasks 3.1, 3.2) |
+| Suggest a follow-up message | `actions` button with `reply` | This plan, Phase 5 |
+| Run host code (export, open a record) | `actions` button with `callback` → `POST /gpt/actions` | This plan, Phase 5 |
+| Get an answer the agent needs to continue | Ask tool call → pause → answer → resume | This plan |
+| Answer from a watch, notification, or other small client | Simple card + headless turn endpoint | This plan |
+
+## Non-Goals
+
+- Interactive HTML (scripts, forms, a bridge that returns a result). MCP Apps parity is future work.
+- App-defined ask kinds with custom renderers. v1 is a closed catalog; apps choose which kinds to enable.
+- Asks outside `GPTChat` and `/gpt/prompt`: MCP elicitation for IDE clients, programmatic `AIService` asks.
+- Camera capture, audio recording, or a desktop drag-and-drop zone beyond `FilePickerButton`.
+- A co-editing canvas. The `markdown` ask is one round trip, not a persistent document.
+- Changing chat attachments (`attachments` on `/gpt/prompt`) or migrating the chat to the AI SDK `useChat` UI message stream.
+- More than one pending ask per conversation.
+- A native Apple Watch app or actionable push notifications (Q7). This plan ships the contract those clients consume; building them stays in Future Work.
+- Finishing long agent turns in a background job after a headless answer. The headless endpoint waits for the turn (see D24).
+- Collecting secrets. There is no password field, and the prompt forbids asking for passwords, card numbers, or API keys.
+
+## Approaches considered
+
+| # | Approach | How the answer returns | Strengths | Costs | Verdict |
+| --- | --- | --- | --- | --- | --- |
+| A | **Client-side ask tools on the existing `/gpt/prompt` SSE.** Each kind is an AI SDK `tool()` with Zod `inputSchema` + `outputSchema` and no `execute`. | The turn pauses at the tool call; the client re-posts the answer; the server resumes the turn with the answer as the tool result. | `toolCallId` binds question to answer. Provider function calling constrains the ask at generation time. Works with plain markdown replies and with `uiBlocks`. Same pattern as AI SDK client tools, MCP elicitation, AG-UI interrupts, and CopilotKit `useHumanInTheLoop`. | New resume path on `/gpt/prompt`; history must replay the paused turn exactly. | **Recommended (Q2)** |
+| B | Same tools, but migrate chat to AI SDK `useChat` + `addToolOutput` (UI message stream). | Same | SDK-managed client tool state; `useTerrenoChat` stub already exists in `@terreno/rtk`. | Rewrites the SSE contract every host parses, `GptHistory` storage, and the Agent UI Blocks SSE events. | Rejected for v1 |
+| C | Form blocks inside the Agent UI Blocks YAML reply (Slack Block Kit `input` + `view_submission`). | Submit posts the values as the next user message. | One wire format. | No binding to a specific question; values arrive as user text or an ad-hoc message; requires `uiBlocks`; free-text YAML is more error-prone than function calling. | Rejected |
+| D | Interactive HTML mini-apps (MCP Apps / OpenAI Apps SDK). | `postMessage` bridge | Unlimited UI | No React Native host exists (MCP Apps specifies a web double iframe); largest phishing and exfiltration surface; the opposite of a strict catalog. | Rejected for v1 (Q3) |
+
+## Decisions
+
+| ID | Question | Decision | Status |
+| --- | --- | --- | --- |
+| D1 | How does this plan relate to Agent UI Blocks? (Q1) | One plan as of 2026-10-01. Ask schemas stay in `@terreno/blocks` under `src/asks/`. The body-component contract (whole-reply YAML, catalog, `BlocksView`, datasets, actions) is Phase 5 of this plan. `html`, `callout`, `image`, and `details` stay Tasks 3.1 and 3.2 (D3, D7). The original design record remains [`agent-ui-blocks.md`](./agent-ui-blocks.md). | **confirmed** (Q1 = A, revised 2026-10-01) |
+| D2 | How does the answer get back to the agent? (Q2) | Approach A: client-side ask tools, pause at the tool call, resume via `POST /gpt/prompt` with `askResponse` (chat) or the `turn` action (small clients, D24). | **confirmed** (Q2 = A) |
+| D3 | Full HTML? (Q3) | Display-only `html` block, opt-in per app (`uiBlocks.html: true` on the server, `allowHtml` on the client). Server-sanitized, rendered in a sandboxed iframe (web) or a JavaScript-disabled WebView (native), no scripts, no network, no links, at most 100 KB. | **confirmed** (Q3 = A) |
+| D4 | Which ask kinds ship in v1? (Q4) | `choice` (one or many, optional "Other"), `files` (images and documents), `markdown` (edit a draft), `confirm` (approve/deny, destructive style), `form` (1–8 flat fields). Rating scale and signature are deferred. | **confirmed**: `choice`, `files`, `markdown` (original request), `confirm` (follow-up: "simple approve/cancel buttons"), `form` (Q4 = form). Rating scale and signature **deferred** (Q4). |
+| D5 | Where do uploaded files live? (Q5) | Adaptive. When `FileStorageService` is configured, the client uploads through `POST /files/upload` and the answer carries `fileId`s (owner-checked `FileAttachment`). Otherwise the answer carries data URLs, like chat attachments today. | **confirmed** (Q5 = A) |
+| D6 | Can the user type a message while an ask is pending? (Q8) | Yes. Sending a message stores a `cancel` answer for the pending ask, then appends the message, so the model sees both. | **confirmed** (Q8 = A) |
+| D7 | Which extra display blocks join the catalog with `html`? (Q9) | `callout` (`Banner`, not dismissible), `image` (`Image`, `alt` required; allowed sources per D27), `details` (`Accordion`). | **confirmed** (Q9 = A) |
+| D8 | Can an ask show blocks (chart, table, HTML) above its control? (Q11) | Not in v1. The ask `prompt` is plain text. Block "context" on asks is future work. | **confirmed** (Q11 = A, with the shared understanding) |
+| D27 | Which image URLs may the `image` block load? (Q12) | File refs and `data:` URLs always; `https` only from hosts the app lists in `uiBlocks.imageHosts` (default empty), otherwise `IMAGE_HOST_NOT_ALLOWED`. An agent that was fed hostile content cannot leak conversation data through image URLs it controls. Markdown images in `text` blocks keep today's `MarkdownView` behavior. | **confirmed** (Q12 = A, with the shared understanding) |
+| D9 | Can a host tool require an approval the server enforces? (Q10) | Yes, through AI SDK tool approval. A host tool sets `needsApproval` (boolean or a function of its input). The server turns each approval request into a server-made `confirm` ask with Approve / Deny, so the model cannot skip it and a watch can answer it. Details in [Server-enforced approval](#server-enforced-approval-q10). | **confirmed** (Q10 = A) |
+| D21 | How do small screens (Apple Watch, notifications, voice, Slack) render asks? (Q6) | The server derives a **simple card** for every ask with a pure function: text ≤ 140 chars and up to 3 buttons, each carrying its exact answer. Asks that cannot shrink set `handoff: true` ("Continue on your phone"). Small clients also send `surface: "compact"` so the agent only asks button-sized questions (D25). | **confirmed** (Q6 = A) |
+| D22 | How much Apple Watch support ships in this plan? (Q7) | Protocol-ready only: simple cards, a pending-asks list, and a non-streaming turn endpoint any native client can call, plus a watch-sized preview in the demo and a SwiftUI client sketch in the how-to. Actionable push notifications and a sample watchOS app stay in Future Work; no follow-up plan is committed. | **confirmed** (Q7 = "just A") |
+| D28 | Phase 3 needs the block schema and renderer. Ship Phases 1–2 now, build those prerequisites here, or leave them on a separate blocks branch? (Q13) | Revised 2026-10-01: this plan implements the full body-component IP. Tasks B1.1–B4.2 are the former Agent UI Blocks tasks. Tasks 3.1 and 3.2 stay here and start after B1.1 and B2.1. Phases 1–2 already shipped. | **confirmed** (user directive 2026-10-01; supersedes Q13 = A) |
+| D10 | Tool shape | One tool per kind: `ask_choice`, `ask_confirm`, `ask_markdown`, `ask_form`, `ask_files`. Each input root is an object (OpenAI strict mode and Gemini function declarations require it). Every schema is `.strict()`. Host tools whose names start with `ask_` fail at startup. | assumed |
+| D11 | Pause semantics | Ask tools have no `execute`, so the AI SDK step loop ends with finishReason `tool-calls`. One pending ask per history, held in `GptHistory.pendingAsk`. If one step emits two ask calls, the first becomes pending and the second gets a stored `cancel` answer with `reason: "one_ask_at_a_time"`, which the model sees on resume. Revised in Pick: two turns on one history that pause at the same time follow the same rule; `pendingAsk` is set with a conditional update only when empty, and the losing turn's ask is stored as that `cancel`. Approvals (D9) share the one slot: in a step with several approval requests, or an ask plus an approval request, the first becomes the pending ask and every extra approval request is answered `approved: false` with reason `one_ask_at_a_time`, so the tool never runs unapproved and the model can request it again later. | assumed |
+| D12 | Answer envelope | `{action: "accept", content}` \| `{action: "decline"}` \| `{action: "cancel", reason?}` — the MCP elicitation shape. `decline` means the user pressed Skip. `cancel` means the ask was superseded (D6) or dropped (D11). | assumed |
+| D13 | Validation | Twice, same functions. Model side: the AI SDK checks the tool input against `inputSchema`; a `superRefine` adds semantic rules (unique ids, defaults among options, min ≤ max). Invalid input returns to the model as a tool error within `maxSteps` and is never sent to the client. User side: `validateAskResponse(input, response)` runs in `GPTChat` before Submit and on the server before resume (400 with `fields` on failure). | assumed |
+| D14 | Resume fidelity | On pause, store the turn's AI SDK `response.messages` on `pendingAsk`. They include provider metadata such as Gemini 3 thought signatures, which the Google provider otherwise replaces with a skip-validator sentinel. Resume replays them verbatim, then appends the tool result. For completed turns, `buildMessages` includes ask call/result pairs. Non-ask tool rows stay skipped, so existing apps see no change. | assumed |
+| D15 | SSE events | Adds `{ask: {toolCallId, kind, input, simple}}`, `{askResolved: {toolCallId, action}}`, and `pendingAsk: {toolCallId}` on `{done}`. Ask tools never emit the generic `{toolCall}` / `{toolResult}` events. | assumed |
+| D16 | Files reach the model | The tool's `toModelOutput` returns an AI SDK `content` output. Images become `image-data` parts and PDFs `file-data` parts; `@ai-sdk/google` 3.0.122 forwards both as multimodal function-response parts. Text, CSV, and JSON files become text parts, truncated at 100 KB with a note. MIME type is sniffed from the bytes and must match the declared type and the ask's `accept` list. | assumed |
+| D17 | HTML render safety | Details in [HTML block](#html-block-display-only). In short: server sanitizer allowlist; CSP `default-src 'none'`; iframe `sandbox=""`; WebView with JavaScript and navigation off; fixed height; a visible "Agent-generated preview" label; rendered only from the completed, sanitized document. | assumed |
+| D18 | Quick replies | A `choice` with `select: one` whose options fit a simple card (at most 3, labels ≤ 20 chars) renders in `GPTChat` as that card's buttons, submitting on tap, so phone and watch show the same buttons. | assumed |
+| D19 | Logging | `AIRequest.metadata.ask = {kind, toolCallId, phase: "asked" \| "answered", action?}`. `requestType` stays `general` because both halves are chat generations. | assumed |
+| D20 | Limits | One source of truth, `ASK_LIMITS`, shared by schema, prompt, docs, and tests. Values in [Limits](#limits). | assumed |
+| D23 | Simple card contract | `toSimpleCard(toolCallId, input)` in `@terreno/blocks`, rules in [Simple cards](#simple-cards-for-small-screens). At most 3 buttons: Android shows 3 notification actions, iOS banners show 2 of up to 4. Labels ≤ 20 chars. Every button's `response` must pass `validateAskResponse` (property test over all fixtures). Computed once when the ask is made, stored on `pendingAsk.simple`, sent in the `{ask}` event. Revised in Pick: label-collision fallback (when the buttons cannot tell options apart, the card shows only Skip and sets `handoff`). | assumed |
+| D24 | Headless endpoints | `modelRouter` actions on `/gpt/histories`: collection action `GET pendingAsks` (the caller's pending asks with simple cards) and instance action `POST :id/turn` (non-streaming; body is one of `{prompt}`, `{askResponse}`, `{toolCallId, buttonId}`, plus optional `surface`). Returns `{text, pendingAsk?}` when the turn finishes. `/gpt/prompt` (SSE) and `turn` share one turn runner. A turn finishes and is saved even if the client disconnects. Revised in Pick: both actions exist only with asks on, so a host that never turned asks on gets no new endpoints after upgrading. `AiApp` adds them when its `asks` option is set; `addGptHistoryRoutes` adds them when its `chat` option, the options given to `addGptRoutes`, turns `asks` on. `turn` returns `{historyId, text, title?, pendingAsk?, error?}`; a model error after the turn starts returns 200 with `error` and the text so far. | assumed |
+| D25 | Compact surface mode | `surface: "compact"` on `/gpt/prompt` or `turn` offers only `ask_confirm` and a narrowed `ask_choice` (`select: one`, 2–3 options, labels ≤ 20), and appends one prompt line: keep replies to two short sentences and ask only yes/no or up to three short options. | assumed |
+| D26 | Button order and safety | Primary answer first, Cancel last. A `destructive` confirm marks its approve button `destructive`, so Apple Watch Double Tap, which triggers the first non-destructive action, can never approve it. | assumed |
+
+## Architecture
+
+```
+                                  MODEL
+  system prompt ◄── TERRENO_ASKS_SYSTEM_PROMPT(enabled kinds, limits)        @terreno/ai
+  tools         ◄── createAskTools(kinds) = {ask_choice, ask_confirm, …}     (Zod from @terreno/blocks)
+       │
+       ▼  tool call ask_choice({prompt, options, select})
+  AI SDK validates input (inputSchema + superRefine) ── invalid ──► tool error back to model (retry)
+       │ valid, no execute → step loop ends (finishReason: tool-calls)
+       ▼
+  simple = toSimpleCard(toolCallId, input)            text ≤ 140 + ≤ 3 buttons, each with its exact answer
+       │
+  POST /gpt/prompt  ── SSE {ask: {toolCallId, kind, input, simple}} ── SSE {done, historyId, pendingAsk}
+       │  GptHistory.pendingAsk = {toolCallId, kind, input, simple, responseMessages}
+       │  GptHistory.prompts += {type: "tool-call", toolName: "ask_choice", ask: {status: "pending"}}
+       ▼
+  ┌─ Full client ─────────────────────────────┐   ┌─ Small client (watch app, notification, Slack) ─┐
+  │ GPTChat ── AskCard(kind)                   │   │ GET /gpt/histories/pendingAsks → simple cards    │
+  │ validateAskResponse on every change        │   │ renders text + buttons, knows no ask kinds       │
+  │ onAskSubmit({toolCallId, response})        │   │ tap → POST /gpt/histories/:id/turn               │
+  │ POST /gpt/prompt {historyId, askResponse}  │   │        {toolCallId, buttonId, surface: compact}  │
+  └────────────────────┬───────────────────────┘   └────────────────────┬─────────────────────────────┘
+                       ▼                                                ▼
+  shared turn runner: pendingAsk matches toolCallId? (409) · owner? (403)
+       │  buttonId → the stored button's response · validateAskResponse + file checks (400 {fields})
+       │  prompts += tool-result; ask.status = answered; pendingAsk cleared (atomic)
+       ▼
+  streamText(messages = history before turn + user message + responseMessages + tool result)
+       ▼
+  SSE {askResolved} → {text} / {toolCall} / {blocks} / {ask} … → {done}      (full client)
+  JSON {text, pendingAsk?: {toolCallId, simple}}                             (small client)
+```
+
+Layers and ownership:
+
+| Layer | Package | Owns |
+| --- | --- | --- |
+| Contract | `@terreno/blocks` (`src/asks/`) | Zod input and answer schemas per kind, `askResponseSchema`, `validateAskInput` (semantic rules), `validateAskResponse`, `toSimpleCard`, compact-surface schema variants, `ASK_LIMITS`, `ASK_ERROR_CODES`, `askPromptSection(kinds, surface)`, fixtures, exported JSON Schema for native clients; `html` block schema |
+| Producer | `@terreno/ai` | `asks` route option, `createAskTools`, `TERRENO_ASKS_SYSTEM_PROMPT`, the shared turn runner behind `/gpt/prompt` (SSE) and `turn` (JSON), `pendingAsks` and `turn` actions on `/gpt/histories`, `GptHistory.pendingAsk`, `buildMessages` ask pairs, file resolution + MIME sniffing + `toModelOutput`, HTML sanitizer, logging |
+| Renderer | `@terreno/ui` | `AskCard` and one renderer per kind, `SimpleAskCard` (renders any simple card), `GPTChat` ask props, answered summaries, `HtmlFrame`, `html` block renderer in `BlocksView` |
+| Proof | `demo`, `example-*` | `AskCard`, `SimpleAskCard` (watch-sized frame), and `HtmlFrame` stories, example AI tab wiring, e2e with mocked SSE, supertest for the headless endpoints |
+
+## The ask catalog (v1, recommended)
+
+Every ask input shares these fields:
+
+| Field | Type | Rule |
+| --- | --- | --- |
+| `prompt` | string | Required, 1–500 chars, plain text (no markdown, no clickable links) |
+| `title` | string | Optional, at most 80 chars |
+| `submitLabel` | string | Optional, at most 24 chars, default "Submit" |
+| `allowDecline` | boolean | Default `true` (shows Skip); `confirm` defaults to `false` because Deny is its negative answer |
+
+### `choice` — pick one or many
+
+```yaml
+tool: ask_choice
+input:
+  prompt: Which plan should I set up?
+  select: one            # one | many
+  options:
+    - {id: starter, label: Starter, description: "$0, one seat"}
+    - {id: team, label: Team, description: "$20 per seat"}
+    - {id: enterprise, label: Enterprise}
+  default: [team]
+answer: {action: accept, content: {selected: [team]}}
+```
+
+Optional: `minSelected` (default 1), `maxSelected` (default 1 for `one`, option count for
+`many`), `allowOther` with `otherLabel` (adds a free-text entry; the answer gains `other`).
+Rules: 2–50 options; ids match `^[a-z0-9][a-z0-9_-]{0,63}$` and are unique; `default` ⊆ ids;
+`minSelected` ≤ `maxSelected` ≤ option count. Server rejects ids that were not offered.
+Revised in Pick (Task 2.1): `allowOther` is allowed only with `select: "many"` ("one option or
+your own" is `many` with `maxSelected: 1`); Other counts as one choice, so with Other on the
+default `maxSelected` is the option count + 1 and the cap is option count + 1; `minSelected`
+may be 0 (a `default` below it is valid input but gets no Use suggested button).
+
+### `confirm` — approve or deny
+
+```yaml
+tool: ask_confirm
+input:
+  prompt: Delete 14 completed todos? This cannot be undone.
+  confirmLabel: Delete 14 todos
+  denyLabel: Keep them
+  destructive: true
+answer: {action: accept, content: {confirmed: true}}
+```
+
+Revised in Pick (Task 2.2): `confirm` does not take the shared `submitLabel` (its two buttons
+are the submit). `confirmLabel` / `denyLabel` default to "Confirm" / "Cancel" and must differ
+after trimming, defaults included (`DUPLICATE_LABEL`). With `allowDecline: true` the chat shows
+Skip, but the simple card never does (its two buttons already cover both answers). The
+"confirm before a tool that deletes, sends, spends, or can't be undone" guidance ships in the
+confirm prompt rules and the `ask_confirm` tool description, only when `confirm` is enabled.
+
+### `markdown` — edit a draft
+
+```yaml
+tool: ask_markdown
+input:
+  prompt: Here is a draft announcement. Edit anything, then send it back.
+  initial: |
+    # We're live
+    Today we launched …
+  maxLength: 20000
+answer: {action: accept, content: {markdown: "# We're live\n…", changed: true}}
+```
+
+Revised in Pick (Task 2.3): `minLength` defaults to 0 and counts the text without spaces at
+either end; `maxLength` defaults to 20,000 and counts UTF-16 code units, like `String.length`.
+`minLength` above `maxLength` (or above the 20,000 cap) fails with `RANGE_INVALID`. An
+`initial` that breaks `minLength` or `maxLength` is still a valid ask, but its simple card has
+no Approve draft button. The server checks `changed` against the text: `changed` must be true
+exactly when `markdown` differs from `initial` (empty when unset), or the answer fails with a
+new code, `CHANGED_MISMATCH`. Cancel shows on the simple card only when `allowDecline` is not
+false; the chat shows Skip for the same answer. `markdown` is never offered on the compact
+surface, and `SimpleAskCard` shows "Edit on your phone" for its handoff line.
+
+### `form` — a few fields, one submit
+
+```yaml
+tool: ask_form
+input:
+  prompt: A few details for the invoice.
+  fields:
+    - {id: company, type: text, label: Company name, required: true, maxLength: 120}
+    - {id: seats, type: number, label: Seats, min: 1, max: 500, integer: true}
+    - {id: start, type: date, label: Start date}
+    - {id: region, type: select, label: Region, options: [{id: us, label: US}, {id: eu, label: EU}]}
+    - {id: notify, type: boolean, label: Email me the invoice, default: true}
+answer: {action: accept, content: {values: {company: Acme, seats: 12, start: "2026-10-01", region: us, notify: true}}}
+```
+
+Field types: `text`, `textarea`, `email`, `url`, `phone`, `number`, `date`, `time`,
+`datetime`, `boolean`, `select`, `multiselect`. Every field has `id`, `label`, optional
+`helperText`, `required`, and `default`, plus type rules (`minLength` / `maxLength`,
+`min` / `max` / `integer`, `options`). Dates are ISO strings validated with Luxon. Fields are
+flat: no nesting, no conditional fields, no password or secret type.
+
+Revised in Pick (Task 2.4): dates are validated with Zod's ISO validators, not Luxon, because
+`@terreno/blocks` depends only on Zod. `date` is `YYYY-MM-DD` and must be a real calendar date;
+`time` is 24-hour `HH:mm`; `datetime` needs `Z` or an offset, so the agent never guesses a time
+zone, and seconds are optional (`2026-10-01T09:30Z` is accepted). Every `default` must be a value its field accepts, checked with the answer rules. A blank
+string or an empty list counts as unanswered. `phone` accepts 7–15 digits with optional `+`,
+spaces, dots, dashes, and parentheses; the chat sends E.164 when the number parses. Limits:
+labels 120, helper text 280, `text` 2,000, `textarea` 10,000, `select` / `multiselect` options
+2–50. New codes `REQUIRED_FIELD`, `FIELD_TYPE_MISMATCH`, `OUT_OF_RANGE`, and `INVALID_DATE`;
+form values also reuse `TOO_LONG`, `TOO_SHORT`, `OPTION_NOT_OFFERED`, `DUPLICATE_ID`,
+`DEFAULT_NOT_IN_OPTIONS`, `UNKNOWN_KEY`, and `RANGE_INVALID`. The simple card offers Submit
+defaults only when at least one field has a default and every required field has one. `form` is
+appended after `markdown` in `ASK_KINDS`, never offered on the compact surface, and
+`SimpleAskCard` shows "Fill it in on your phone" for its handoff line. The chat renders `number`
+with `TextField`, not `NumberField`, because `NumberField` rejects keystrokes below `min` (so
+"50" cannot be typed when `min` is 10) and negative numbers; the shared rules report range and
+whole-number errors instead.
+
+### `files` — upload images or documents
+
+```yaml
+tool: ask_files
+input:
+  prompt: Upload a photo of the receipt.
+  accept: [image, pdf]    # image | pdf | text | csv | json
+  minFiles: 1
+  maxFiles: 3
+answer:
+  action: accept
+  content:
+    files:
+      - {fileId: 6710c2…, filename: receipt.jpg, mimeType: image/jpeg, size: 482113}
+```
+
+`accept` maps to the `/files/upload` allowlist: `image` → JPEG, PNG, GIF, WebP; `pdf`;
+`text` → `text/plain`; `csv`; `json`. A file ref is `{fileId}` (uploaded, D5) or `{url}` (a
+`data:` URL). The per-file cap is the host's upload cap (10 MB default); at most 10 files.
+
+Revised in Pick (Task 2.5): `maxFiles` defaults to 10, and each `accept` value may appear once
+(`DUPLICATE_ID`). A data URL's media type must equal the declared `mimeType` (`MIME_MISMATCH`),
+and the server never fetches a remote URL. The byte sniffer (`sniffFileBytes`,
+`checkAskFileBytes`) lives in `@terreno/blocks` with no new dependency: images and PDFs need their
+signature, and text, CSV, and JSON must be UTF-8 without NUL (JSON must parse). The history and the
+`AIRequest` log store only `{fileId?, filename, mimeType, size}` with the real byte count, never
+`url`; the bytes reach the model only on the answering turn, and later turns replay the metadata.
+The model output is `content`: the stored answer as JSON text, then per file a
+`File i of n: name (mime, N bytes)` line and its part, with
+`[The file is cut to its first N of M bytes.]` after a cut text file. To support `fileId`,
+`POST /files/upload` now returns the attachment `id`, `FileStorageService` gains
+`download(gcsKey)`, `GptRouteOptions` gains `fileStorageService` (`AiApp` passes it only when
+`gcsBucket` is set; without it a `fileId` fails with `FILE_NOT_OWNED`), and
+`asks.maxFileSizeBytes` sets both the answer cap and the `/files/upload` cap. How picked files
+become refs is the host's choice: `GPTChat`'s `resolveAskFiles` defaults to data URLs, and the
+example app uploads through `/files/upload` and falls back to data URLs on 404. `SelectedFile`
+gains `size`, and `FilePickerButton` gains `documentTypes`, `includeImages`, and `text`. The
+Submit label defaults to "Submit". The simple card has only Skip (when `allowDecline` is not
+false) with `handoff: true`, `files` is never offered on the compact surface, and `SimpleAskCard`
+shows "Upload on your phone". Known gap: an upload over the cap fails in multer's error handler,
+not with a clean 413.
+
+## Server-enforced approval (Q10)
+
+Confirmed (Q10 = A). A prompt-driven `confirm` depends on the model remembering to ask.
+Server-enforced approval does not: the host marks a tool, and the tool cannot run until the
+user approves. AI SDK 6 already supports it (`needsApproval` on `tool()`, a
+`tool-approval-request` part on the assistant message, a `tool-approval-response` part on
+the tool message), so this reuses the ask pause, the Approve / Deny simple card, and the
+headless `turn` endpoint.
+
+```ts
+const deleteCompletedTodos = tool({
+  description: "Delete the user's completed todos",
+  inputSchema: z.object({}).strict(),
+  needsApproval: true,
+  execute: async () => ({deleted: 14}),
+});
+
+addGptRoutes(router, {
+  aiService,
+  tools: {deleteCompletedTodos},
+  asks: {
+    approvals: {
+      deleteCompletedTodos: () => ({
+        prompt: "Delete all completed todos?",
+        confirmLabel: "Delete",
+        denyLabel: "Keep them",
+        destructive: true,
+      }),
+    },
+  },
+});
+```
+
+| Step | Behavior |
+| --- | --- |
+| Request | The model calls the tool; the SDK emits `tool-approval-request {approvalId, toolCallId}` and does not execute. |
+| Pause | The server stores a pending `confirm` ask with `origin: "approval"`, `toolName`, and `approvalId`. Its input comes from `asks.approvals[toolName](input)`, or defaults to "Allow <toolName>?" with the tool description and Allow / Deny labels. The `{ask}` event and simple card carry it like any other ask. |
+| Answer | `{confirmed: true}` appends `tool-approval-response {approvalId, approved: true}` and resumes; the SDK runs the tool once. `{confirmed: false}`, `decline`, or `cancel` appends `approved: false`; the model is told the user denied it. |
+| Integrity | The approval request and response live only in server-stored messages, so a client cannot forge an approval; the client only sends the answer envelope for the pending ask. |
+| Later turns | The approval row is display-only, like other server tool rows today (D14). |
+
+Revised in Pick (Task 2.6):
+
+- The approval ask's `toolCallId` is the SDK `approvalId`. `pendingAsk` stores it again as
+  `approvalId`, and the resume answers only that approval, never an id from the client.
+- Because approval rows and host tool rows are both skipped on replay, a `prompt` that cancels a
+  pending approval leaves no trace of the call for the model: it sees only the user's messages.
+  The paused step's messages are dropped with the pending ask, as for a model ask.
+- Extra approvals in a step get no rows at pause time. On resume they are denied with
+  `one_ask_at_a_time`, which stores and streams `{approved: false, reason}` tool results.
+- Approvals work whenever asks are on, even when the surface's offered kinds leave out
+  `confirm`. With asks off, a `needsApproval` tool never runs: the SDK stops the step and the
+  server logs a warning.
+- `decline` is accepted only when the approval input sets `allowDecline: true`, because a
+  `confirm` refuses Skip by default. Denial reasons are `user_denied`, `user_declined`, and
+  `user_cancelled` (or the cancel's own reason).
+- The `{ask}` event and `AIRequest.metadata.ask` carry `origin` and `toolName`, but the headless
+  summaries (`turn` and `pendingAsks`) do not, so the published JSON Schemas are unchanged.
+- The approval route tests live in a new `ai/src/routes/gptApprovals.test.ts` instead of
+  `gpt.test.ts` and `gptHistories.test.ts`; the example tool lives in
+  `example-backend/src/api/todoTools.ts`, and the keyless demo agent calls it for "delete my
+  completed todos".
+
+## Simple cards for small screens
+
+Every ask carries a simple card, the lowest common denominator a client can render
+without knowing ask kinds. It plays the role of Slack's `text` fallback, Adaptive Cards'
+`fallbackText`, and Assistant suggestion chips, with one addition: each button already
+holds the exact answer it sends.
+
+```yaml
+simple:
+  toolCallId: call_8f2c1
+  kind: confirm
+  title: Clean up todos                # ≤ 40 chars
+  text: Delete 14 completed todos? This cannot be undone.   # ≤ 140 chars, plain text
+  handoff: false                       # true → "Continue on your phone"
+  buttons:                             # 0–3
+    - id: approve
+      label: Delete 14 todos           # ≤ 20 chars
+      style: destructive               # default | primary | destructive | cancel
+      response: {action: accept, content: {confirmed: true}}
+    - id: deny
+      label: Keep them
+      style: cancel
+      response: {action: accept, content: {confirmed: false}}
+```
+
+Derivation rules (`toSimpleCard`, pure, deterministic; labels over 20 chars are cut at a
+word boundary with "…"; `text` is `prompt` cut to 140 chars):
+
+| Ask | Buttons | `handoff` |
+| --- | --- | --- |
+| `confirm` | `confirmLabel` (style `destructive` when the ask is, else `primary`) → `{confirmed: true}`; `denyLabel` (`cancel`) → `{confirmed: false}` | never |
+| `choice` one, at most 3 options, cut labels all different | One button per option → `{selected: [id]}`: the `default` first (style `primary`), then the rest in option order (style `default`); without a `default`, option order, all `default`. Skip (`cancel`) → `decline` last, when `allowDecline` and room | never |
+| `choice` one, more options | With a `default` (an id array of length 1): Use "<label>" → `{selected: default}`, then Skip | yes |
+| `choice` one, the buttons cannot tell options apart: two cut labels are the same (at most 3 options), or the cut label in Use "<label>" also fits another option (more options) | Skip → `decline` when `allowDecline`; no option or Use "<label>" button | yes |
+| `choice` many | With a valid `default`: Use suggested → `{selected: default}`, then Skip | yes |
+| `markdown` | Approve draft → `{markdown: initial, changed: false}` when `initial` meets the length rules; Cancel → `decline` | yes ("Edit on your phone") |
+| `form` | Submit defaults → `{values: defaults}` when every required field has a valid default; Cancel → `decline` | yes |
+| `files` | Skip → `decline` when `allowDecline` | yes |
+
+Compact surface mode (D25): a small client sends `surface: "compact"` on `/gpt/prompt` or
+`turn`. The agent then gets only `ask_confirm` and a narrowed `ask_choice` (one pick, 2–3
+options, labels ≤ 20), plus a prompt line asking for two-sentence replies. Every card made
+in that mode has `handoff: false`.
+
+Headless endpoints (D24), for clients that cannot or should not parse SSE:
+
+| Endpoint | Kind | Returns |
+| --- | --- | --- |
+| `GET /gpt/histories/pendingAsks` | `collectionActions.pendingAsks` (`IsAuthenticated`, caller's histories) | `[{historyId, title, toolCallId, kind, simple, created}]`, newest first |
+| `POST /gpt/histories/:id/turn` | `instanceActions.turn` (`IsOwner`) | Body is one of `{prompt}`, `{askResponse}`, `{toolCallId, buttonId}`, plus optional `surface`. Runs the turn to completion and returns `{text, pendingAsk?: {toolCallId, kind, simple}}`. Unknown `buttonId` → 400; stale `toolCallId` → 409. |
+
+How an Apple Watch plugs in (documented in the how-to; not built here, Q7 = A):
+
+| Path | What it needs | Status |
+| --- | --- | --- |
+| SwiftUI watch app | Native watchOS target (React Native does not run on watchOS; `@bacons/apple-targets` adds one to an Expo app). The session token reaches the watch over WatchConnectivity; the app calls the two headless endpoints with `URLSession`, always with `surface: "compact"`. | Future Work |
+| Actionable push, no watch app | iOS forwards iPhone notifications with up to 4 action buttons to the watch. Needs `categoryId` on comms push, `data` on `notify()`, templated categories (labels are fixed when the app registers a category), actions with `opensAppToForeground: false`, a small native iOS handler (expo-notifications completes before a JS `fetch` finishes), and a one-time action token per ask. | Future Work |
+
+## Component map — what the chat can render
+
+Asks:
+
+| Ask | `@terreno/ui` component | Rule |
+| --- | --- | --- |
+| `choice` one, ≤ 3 options with labels ≤ 20 | `Button` row (the simple card's buttons) | Tap submits (D18) |
+| `choice` one, ≤ 8 options | `RadioField` | |
+| `choice` one, > 8 options | `SelectField` (searchable) | |
+| `choice` many | `MultiselectField` + `TextField` for "Other" | |
+| `confirm` | Two `Button`s | `destructive` → `variant="destructive"` |
+| `markdown` | `MarkdownEditorField` | Edit and preview; stacks on narrow screens |
+| `form` | `Field` dispatched by type | `TextField`, `TextArea`, `EmailField`, `PhoneNumberField`, `NumberField`, `DateTimeField`, `BooleanField`, `SelectField`, `MultiselectField` |
+| `files` | `FilePickerButton` + `AttachmentPreview` | Image library when `accept` has `image`; document picker otherwise |
+| Any ask, simple card | `SimpleAskCard`: `Heading`, `Text`, up to 3 `Button`s | For narrow layouts and the watch-sized demo preview; native watch apps render the same JSON themselves |
+| Deferred | `Slider`, `ThumbsUpDownFeedback` (rating); `SignatureCaptureField` (signature); `AddressField` (needs a Maps key); `EmojiSelector` | |
+
+Display (the reply document):
+
+| Block | Component | Source |
+| --- | --- | --- |
+| `heading`, `text`, `metric`, `badge`, `divider`, `context`, `table`, `actions`, `columns`, `card` | `Heading`, `MarkdownView`, `Card`, `Badge`, `SectionDivider`, `Text`, `DataTable`, `Button` / `SegmentedControl`, `Box` | This plan, Phase 5 (BD5) |
+| `chart` (`line`, `bar`, `area`, `donut`; inline or `ref` datasets) | `LineChart`, `BarChart`, `AreaChart`, `DonutChart` | This plan, Phase 5 (BD4, BD15). Chart components shipped in PR #1302. |
+| `html` | `HtmlFrame` (new) | This plan (D3) |
+| `callout`, `image`, `details` | `Banner`, `Image`, `Accordion` | This plan (D7, D27) |
+| Not recommended | `Avatar`, `Tooltip`, `Popover`, `SelectBadge`, `TapToEdit`, `DraggableList` | Poor fit for a transcript |
+| Missing | Progress bar (props type only), star rating, sparkline | Future components |
+
+## HTML block (display-only)
+
+```yaml
+- type: html
+  title: Invoice preview
+  height: md            # sm | md | lg → 240 / 400 / 640 px, scrolls inside
+  html: |
+    <h1>Invoice #1042</h1>
+    <table><tr><td>Seats</td><td>12</td></tr></table>
+```
+
+| Layer | Rule |
+| --- | --- |
+| Opt-in | Server `uiBlocks.html: true` adds `html` to the prompt section and validator; otherwise `HTML_DISABLED`. Client `allowHtml` on `GPTChat` / `BlocksView`; when false the block renders a placeholder. |
+| Size | At most 100,000 bytes (`HTML_TOO_LARGE`). |
+| Sanitizer (server, `sanitize-html`) | Removes `script`, `iframe`, `frame`, `object`, `embed`, `form`, `input`, `button`, `select`, `textarea`, `meta`, `base`, `link`; all `on*` attributes; every URL except `data:image/*`; `href` on anchors (text is kept). Runs on the final document; a changed document is stored and re-sent with `{replace: text}`. |
+| Web | `<iframe sandbox="" srcdoc=… referrerpolicy="no-referrer">` (no scripts, same-origin, forms, popups, or top navigation). A CSP meta tag is injected first: `default-src 'none'; img-src data:; style-src 'unsafe-inline'; font-src data:; form-action 'none'; base-uri 'none'`. |
+| Native | `react-native-webview` with `javaScriptEnabled={false}`, `onShouldStartLoadWithRequest` rejecting every load after the first, `incognito`, `dataDetectorTypes="none"`, no `onMessage`, no injected JavaScript. `originWhitelist` is not used as a sandbox: failing URLs would open in the system browser. |
+| Framing | Inside a `Card` captioned "Agent-generated preview", fixed height, no fullscreen, so it cannot pass for host UI. |
+| Streaming | Renders a placeholder until the stream completes, then renders the sanitized document. Raw model HTML never reaches a frame. |
+
+## Models
+
+| Model | Change | Notes |
+| --- | --- | --- |
+| `GptHistory` | Add `pendingAsk?: {toolCallId, kind, input (Mixed), simple (Mixed), responseMessages (Mixed), created}` | One slot enforces one pending ask. `simple` is the card snapshot taken when the ask is made, so later derivation changes never alter a card already shown on a watch. Set atomically only when empty (D11); cleared atomically on answer or cancel (`findOneAndUpdate` on `pendingAsk.toolCallId`). Additive and optional; every field has a `description` (mongoose-schema-safety). |
+| `GptHistory.prompts[]` | Add `ask?: {kind, status: "pending" \| "answered" \| "cancelled"}` on `tool-call` rows | Drives rendering: pending → interactive card, otherwise a read-only summary. `tool-result` rows store the answer envelope in `result`. |
+| `FileAttachment` | None | Reused for `fileId` refs (owner check). |
+
+## APIs
+
+| Surface | Change |
+| --- | --- |
+| `addGptRoutes(router, {asks?: boolean \| AsksOptions})` | `AsksOptions = {kinds?: AskKind[], maxFileSizeBytes?: number, approvals?: Record<toolName, (input) => ConfirmAskInput>}` (D9). The Agent UI Blocks `uiBlocks` option gains `html?: boolean` (D3) and `imageHosts?: string[]` (D27). When enabled, merges `createAskTools(kinds)` into the tool set and appends `TERRENO_ASKS_SYSTEM_PROMPT`. Off by default; with it off, tools, prompt, and SSE are unchanged. |
+| `POST /gpt/prompt` body | Adds `askResponse?: {toolCallId, action, content?}` and `surface?: "full" \| "compact"` (D25). `prompt` becomes optional when `askResponse` is present (400 when both are missing). A `prompt` sent while an ask is pending records `cancel` first (D6). |
+| `POST /gpt/prompt` responses | 400 `{fields}` for an invalid answer (no model call); 403 for another user's history; 409 when `toolCallId` is not the pending ask. |
+| SSE | `{ask: {toolCallId, kind, input, simple}}`, `{askResolved}`, `{done: …, pendingAsk?}` (D15). `docs/reference/ai.md` gets the first complete SSE event table. |
+| `GET /gpt/histories/pendingAsks` | New collection action (D24): the caller's pending asks with their simple cards. |
+| `POST /gpt/histories/:id/turn` | New instance action (D24): non-streaming turn for small clients; accepts a prompt, a full answer, or a simple-card `buttonId`. |
+| `@terreno/ai` exports | `createAskTools`, `AsksOptions`, `AskKind`, answer and simple-card types. |
+| `@terreno/blocks` exports | Ask input and answer schemas, `askResponseSchema`, `validateAskInput`, `validateAskResponse`, `toSimpleCard`, `simpleCardSchema`, `askPromptSection`, `ASK_LIMITS`, `ASK_ERROR_CODES`, types, a JSON Schema file for native clients (Swift `Codable` types can be generated from it); `html` block schema. |
+
+Error shape matches Agent UI Blocks: `{path, code, message, fix}`. Codes include
+`UNKNOWN_KEY`, `DUPLICATE_ID`, `DEFAULT_NOT_IN_OPTIONS`, `RANGE_INVALID`, `OPTION_NOT_OFFERED`,
+`SELECTION_COUNT`, `OTHER_NOT_ALLOWED`, `REQUIRED_FIELD`, `FIELD_TYPE_MISMATCH`,
+`OUT_OF_RANGE`, `INVALID_DATE`, `TOO_LONG`, `FILE_TYPE_NOT_ACCEPTED`, `FILE_TOO_LARGE`,
+`FILE_COUNT`, `FILE_NOT_OWNED`, `MIME_MISMATCH`, `UNKNOWN_BUTTON`, `HTML_DISABLED`,
+`HTML_TOO_LARGE`, `IMAGE_HOST_NOT_ALLOWED`.
+
+## Limits
+
+| Limit | Value |
+| --- | --- |
+| `prompt` / `title` / labels / descriptions | 500 / 80 / 120 / 280 chars |
+| `confirm` `confirmLabel` / `denyLabel` | 20 chars each, so they fit a simple card unchanged |
+| `choice` options | 2–50; compact surface 2–3 with labels ≤ 20 |
+| Simple card | `title` ≤ 40, `text` ≤ 140, 0–3 buttons, labels ≤ 20 chars |
+| `form` fields | 1–8; `text` ≤ 2,000 chars; `textarea` ≤ 10,000; `select` options 2–50 |
+| `markdown` `initial` and answer | ≤ 20,000 chars |
+| `files` | ≤ 10 files; per file ≤ host cap (10 MB default); text-like files reach the model truncated at 100 KB |
+| `html` | ≤ 100,000 bytes |
+| Pending asks per history | 1 |
+
+## UI
+
+| Component | Package | Notes |
+| --- | --- | --- |
+| `GPTChat` | `@terreno/ui` | `GPTChatMessage` gains `ask?: {toolCallId, kind, input, status, response?}`. New props `onAskSubmit?: ({toolCallId, response}) => void \| Promise<void>`, `askErrors?: Record<toolCallId, AskFieldErrors>`, `allowHtml?: boolean`. A pending ask renders `AskCard` in the transcript and moves focus to it; answered asks render a one-line summary ("You chose: Team"); long markdown answers collapse. File answers pass `SelectedFile[]`; the host uploads or encodes them (D5). |
+| `AskCard` + `AskChoice`, `AskConfirm`, `AskMarkdown`, `AskForm`, `AskFiles` | `@terreno/ui` (`src/asks/`) | Submit enabled only when `validateAskResponse` passes; inline field errors from the client check or server `fields`; Skip when `allowDecline`; loading state while `onAskSubmit` is pending. Lazy via `heavyOptionalExports` (pulls `MarkdownEditorField`, file picker). |
+| `SimpleAskCard` | `@terreno/ui` (`src/asks/`) | Props `{card: SimpleCard, onPress: (button) => void, pendingButtonId?}`. Renders `title`, `text`, up to 3 buttons (`destructive` / `cancel` styles), and a "Continue on your phone" line when `handoff`. Knows nothing about ask kinds. |
+| `HtmlFrame` | `@terreno/ui` | Web iframe / native WebView per [HTML block](#html-block-display-only); follows the `MarkdownEmbed` platform split. |
+| Stories | `demo` | `AskCard` (every kind, pending / error / answered), `SimpleAskCard` inside a 198×242 pt frame (Apple Watch 45 mm) for every fixture, and `HtmlFrame` (sanitized sample, disabled placeholder). |
+
+## Phases
+
+| Phase | Slice | Proves |
+| --- | --- | --- |
+| 1 | Tracer: `choice` (select one) end to end, then the small-screen path | Mock-model supertest: pause → SSE `ask` → answer → resumed model call sees the tool result; `GPTChat` renders and submits; example app e2e with mocked SSE; a simple-card `buttonId` sent to `turn` resumes the same way |
+| 2 | Remaining kinds: `choice` many + Other, `confirm`, `markdown`, `form`, `files` | One vertical slice per kind: schema, answer validation, simple-card rule, renderer, docs, tests |
+| 3 | `html`, `callout`, `image`, and `details` blocks (after B1.1 and B2.1) | Sanitizer and frame security tests; image host rule; `BlocksView` renders; demo screenshots |
+| 4 | Asks wrap-up for Phases 1–2 | Changelog, rules, docs indexes (shipped 2026-09-27; Tasks 3.1 and 3.2 add their own lines) |
+| 5 | Body components: contract, renderer, producer, examples | Whole-reply YAML, `BlocksView`, `uiBlocks`, datasets, actions. See [Body components](#body-components-agent-ui-blocks). Blocks AC1–AC20 |
+
+## Feature Flags & Migrations
+
+None. `asks` and `uiBlocks.html` are off unless the host passes them. Schema changes are
+additive optional fields; no backfill.
+
+## Activity Log & User Updates
+
+None beyond `AIRequest` metadata (D19).
+
+## Not Included / Future Work
+
+- Block context above an ask's control (D8): chart, table, or HTML previews such as "Send this email?".
+- Rating scale (`Slider` / `ThumbsUpDownFeedback`), signature (`SignatureCaptureField`), address (`AddressField`).
+- Camera capture and audio recording.
+- App-defined ask kinds with custom renderers.
+- MCP elicitation mapping so IDE agents on the app `/mcp` endpoint can use the same asks.
+- Interactive HTML with a result bridge (MCP Apps).
+- Pending-ask expiry.
+- Actionable ask notifications (Q7 B): comms push `categoryId` / `collapseId`, `data` on `notify()`, templated iOS categories, a native iOS action handler, one-time action tokens scoped to ask + user + buttons with expiry, `isAuthenticationRequired` on destructive buttons, and a device spike on a real iPhone + Watch (locked phone, force-quit app).
+- A sample SwiftUI watchOS app in `example-frontend` via `@bacons/apple-targets` (Q7 C), and Wear OS.
+- Finishing long turns in a `@terreno/jobs` background job so a headless answer can return immediately.
+
+## Files to Create / Modify
+
+| Package | Files |
+| --- | --- |
+| `blocks/` | `src/asks/schema.ts`, `src/asks/limits.ts`, `src/asks/errors.ts`, `src/asks/validateInput.ts`, `src/asks/validateResponse.ts`, `src/asks/simpleCard.ts`, `src/asks/prompt.ts`, `src/asks/jsonSchema.ts`, `src/asks/fixtures/**`, `src/asks/*.test.ts`, `src/index.ts`; `src/schema.ts` (`html`, `callout`, `image`, `details` blocks); package scaffold (`package.json`, `tsconfig.json`, `biome.jsonc`, CI job) only if Agent UI Blocks Task 1.1 has not landed |
+| `ai/` | `src/service/asks.ts` (`createAskTools`, `toModelOutput`, resume helpers), `src/service/chatTurn.ts` (turn runner shared by SSE and JSON), `src/service/askFiles.ts` (ref resolution, MIME sniffing), `src/service/sanitizeHtml.ts`, `src/service/prompts.ts` (`TERRENO_ASKS_SYSTEM_PROMPT`), `src/routes/gpt.ts`, `src/routes/gptHistories.ts` (`pendingAsks`, `turn` actions), `src/models/gptHistory.ts`, `src/service/aiService.ts` (`buildMessages`), `src/types/index.ts`, `src/index.ts`, `package.json` (`@terreno/blocks`, `sanitize-html`), tests |
+| `ui/` | `src/asks/AskCard.tsx`, `src/asks/SimpleAskCard.tsx`, `src/asks/AskChoice.tsx`, `src/asks/AskConfirm.tsx`, `src/asks/AskMarkdown.tsx`, `src/asks/AskForm.tsx`, `src/asks/AskFiles.tsx`, `src/asks/askSummary.ts`, `src/HtmlFrame.tsx`, `src/GPTChat.tsx`, `src/lazyBoundaries/heavyOptionalExports.tsx`, `src/index.tsx`, `package.json` (`@terreno/blocks`), tests; `src/blocks/blockRenderers.tsx` (`html`, `callout`, `image`, `details`) after Agent UI Blocks Task 2.1 |
+| `demo/` | `stories/AskCard.stories.tsx`, `story-config/AskCard.config.tsx`, `stories/SimpleAskCard.stories.tsx`, `story-config/SimpleAskCard.config.tsx`, `stories/HtmlFrame.stories.tsx`, `story-config/HtmlFrame.config.tsx`, `demoConfig.tsx` |
+| `example-backend/` | `src/api/ai.ts` (`asks: true`, later `uiBlocks.html`) |
+| `example-frontend/` | `app/(tabs)/ai.tsx`, `e2e/helpers/mockGpt.ts`, `e2e/ai-chat.spec.ts` |
+| root | `package.json` (catalog `sanitize-html`), `knip.jsonc`, `changelog/unreleased/agent-ui-asks.md` |
+| docs | `docs/explanation/agent-ui-asks.md` (new), `docs/reference/agent-ui-asks.md` (new), `docs/how-to/agent-ui-asks.md` (new), `docs/reference/ai.md`, `docs/reference/ui.md`, `docs/explanation/example-coverage.md`, `docs/explanation/README.md`, `docs/reference/README.md`, `docs/how-to/README.md`, `.rulesync/rules/ai/00-ai.md`, `.rulesync/rules/ui/00-ui.md` |
+
+## Body components (Agent UI Blocks)
+
+On 2026-10-01 the user directed Pick to roll the body-component IP into this plan.
+[`agent-ui-blocks.md`](./agent-ui-blocks.md) stays the design record (goal, approaches,
+grammar examples, architecture diagram, models, and the original AC wording). This
+section is the execution source: decisions BD1–BD20 are that plan's D1–D20, and tasks
+B1.1–B4.2 in [`docs/tasks/agent-ui-asks.md`](../tasks/agent-ui-asks.md) are that plan's
+tasks. `@terreno/blocks` already exists for asks; Phase 5 extends it. It does not
+create a second package.
+
+When `uiBlocks` is on, every assistant reply is one YAML document: `v`, then optional
+`datasets`, then `blocks`. Prose is a `text` block. The agent can only emit the closed
+catalog. Charts bind to named datasets (`inline` ≤ 500 rows, or `ref` to an `AIDataset`
+handle a tool returned). Buttons use `reply`, `open`, `select`, or `callback`.
+
+| ID | Decision | Status |
+| --- | --- | --- |
+| BD1 | Own the grammar (Approach A). Contract lives in `@terreno/blocks`. | confirmed |
+| BD2 | The whole assistant reply is one YAML document (`v` → `datasets` → `blocks`). A leading or trailing fence is stripped. JSON is accepted. A non-document is wrapped as one `text` block and reported as `NOT_A_DOCUMENT`. | confirmed |
+| BD3 | Nested, depth ≤ 2 (`blocks` → `columns`/`card` → leaf). Ids optional except on interactive blocks. | assumed |
+| BD4 | Datasets are `inline` (typed columns + rows, ≤ 500) or `ref` (`{source: ref, id, grain?, limit?}`). Charts and tables use `data` plus column names. One-off charts may use `points`. | confirmed |
+| BD5 | v1 catalog: `heading`, `text`, `metric`, `badge`, `divider`, `context`, `chart`, `table`, `actions`, `columns`, `card`. Asks Tasks 3.1 and 3.2 add `html`, `callout`, `image`, `details`. | assumed |
+| BD6 | Actions: `reply`, `open`, `select`, `callback`. `callback` posts `POST /gpt/actions`; hosts register `hostActions` with a Zod payload. Unknown names fail `UNKNOWN_HOST_ACTION`. | confirmed |
+| BD7 | Unknown keys fail. ≤ 50 blocks, depth ≤ 2, ≤ 25 action elements, ≤ 4 columns, ≤ 8 datasets, inline ≤ 500×12, `ref` limit ≤ 1,000 rendered rows (≤ 60 bar/donut categories), ≤ 8 donut slices, text ≤ 4,000 per block, ≤ 20,000 per document. | assumed |
+| BD8 | Contract package is the existing `blocks/` (`zod` catalog, `yaml` catalog). No React, no Express. | confirmed |
+| BD9 | Styling is semantic enums already on `@terreno/ui` (`size`, `status`, `variant`, `trend`). No hex, no spacing numbers. | assumed |
+| BD10 | `parseBlocksPartial` returns completed top-level blocks while streaming; `GPTChat` shows a `Spinner` for the tail. Full validation replaces that render on `{done}`. | assumed |
+| BD11 | One `validateBlocks`: post-stream SSE `{blocks}`, optional one repair pass, MCP `terreno_validate_ui_blocks`, `AIService.generateBlocks`, CLI `terreno-blocks validate`. | assumed |
+| BD12 | Errors are `{path, code, message, fix}` sorted by path. Warnings share the shape and do not block rendering. | assumed |
+| BD13 | Required `v: 1`. Unknown major → `UNSUPPORTED_VERSION`. | assumed |
+| BD14 | Demo `BlocksView` story and Blocks Playground; example AI tab turns `uiBlocks` on; example-backend registers one host action and one dataset tool. | assumed |
+| BD15 | `chart` targets the shipped single-series chart components (PR #1302). Multi-series stays rejected. | confirmed |
+| BD16 | One document per assistant message, stored as the raw string. | assumed |
+| BD17 | Only server tools call `registerAiDataset`. The agent cannot mint handles. `GET /gpt/datasets/:id` is `IsOwner`. | confirmed |
+| BD18 | `AIDataset` retention defaults to unlimited (`datasetTtlDays: 0`). Cap `datasetMaxRows` default 50,000. `grain` buckets dates; line/area over `limit` uses LTTB. | confirmed |
+| BD19 | `POST /gpt/actions` body `{historyId, messageId, blockId, elementId, name, payload}`; owner check; 10 s handler timeout; `requestType: "ui_action"`. | assumed |
+| BD20 | No prose before tool calls. Only the final step's text is the document. | assumed |
+
+Block reference (field tables land in `docs/reference/blocks.md` with B1.1 and later tasks):
+
+| Block | Required | Renders | Task |
+| --- | --- | --- | --- |
+| `heading`, `text`, `metric`, `badge`, `divider`, `context`, `columns`, `card` | See design record | `@terreno/ui` equivalents | B1.1 schema, B2.1 renderer |
+| `chart`, `table`, datasets | `kind` + `data` or `points`; `data` for tables | Chart components, `DataTable` | B1.2, B2.2 |
+| `actions` | `id`, `elements` | `Button`, `SegmentedControl` | B1.3, B2.3 |
+| `html`, `callout`, `image`, `details` | Asks D3, D7, D27 | `HtmlFrame`, `Banner`, `Image`, `Accordion` | Tasks 3.1, 3.2 after B1.1 and B2.1 |
+
+`parseBlocks` strips an optional fence, parses YAML or JSON (`schema: "core"`, unique keys, no anchors or custom tags), and returns `NOT_A_DOCUMENT` when the value is not a mapping with `v`. `wrapAsTextDocument` builds the display fallback. `validateBlocks` is pure and sync: Zod `strict()` structure, then semantic lint (lint starts in B1.2).
+
+### Body component acceptance
+
+These ids are **Blocks AC**. They do not renumber the asks AC table below.
+
+| # | Criterion | Verification |
+| --- | --- | --- |
+| Blocks AC1 | Every fixture under `blocks/src/fixtures/valid/` validates with zero errors; every fixture under `invalid/` fails with exactly the expected `{path, code}` pairs | `bun test blocks/` golden test |
+| Blocks AC2 | Unknown keys, wrong enums, wrong key order, missing dataset/column refs, non-document input, and each BD7 limit produce a distinct documented error code | `blocks/src/validate.test.ts`; `docs/reference/blocks.md` lists the same codes |
+| Blocks AC3 | `validateBlocks` on a 50-block, 8-dataset document completes in < 5 ms median | `blocks/src/validate.perf.test.ts` |
+| Blocks AC4 | `blocksJsonSchema` accepts and rejects the same fixtures as the Zod schema | ajv round-trip |
+| Blocks AC5 | `BlocksView` renders every v1 block type with `@terreno/ui` components only | `BlocksView.test.tsx` + `rg` guard |
+| Blocks AC6 | Invalid document → error `Banner` and collapsed raw YAML; non-document text → one `text` block | `BlocksView.test.tsx` |
+| Blocks AC7 | `reply` calls `onSubmit`; `open` reaches `onBlockAction`; `callback` reaches `onBlockCallback` | `GPTChat.test.tsx` |
+| Blocks AC8 | `segmented` switches the target chart's dataset and reports `select` | `BlocksView.test.tsx` |
+| Blocks AC9 | `/gpt/prompt` with `uiBlocks` appends the prompt, treats the final step as the document, and emits SSE `{blocks}` before `{done}`; `repair: true` runs one repair call | `ai/src/routes/gpt.test.ts` |
+| Blocks AC10 | `generateBlocks` returns a validated document; one repair call includes the error codes | `aiService.test.ts` |
+| Blocks AC11 | MCP `terreno_validate_ui_blocks` matches the CLI report | mcp-server test + CLI test |
+| Blocks AC12 | Demo `BlocksView` story and Blocks Playground; demo coverage passes | CI + screenshots |
+| Blocks AC13 | example-frontend renders a bar chart from a mocked document and a follow-up reply | e2e + recording |
+| Blocks AC14 | Explanation, reference, and how-to pages exist and are linked; `ai.md`, `ui.md`, `mcp-server.md` updated | `bun run website:build` |
+| Blocks AC15 | `bun run prepush` green | CI |
+| Blocks AC16 | `GET /gpt/datasets/:id` buckets, downsamples, and paginates; TTL 0 vs 7 | dataset tests |
+| Blocks AC17 | `POST /gpt/actions` rejects unknown name, bad payload, and non-owner; a valid call returns `{blocks, replace}` | `gptActions.test.ts` |
+| Blocks AC18 | Over-cap `ref` limit → `TOO_MANY_POINTS`; unregistered callback → `UNKNOWN_HOST_ACTION` | lint + gpt tests |
+| Blocks AC19 | Callback button shows `loading`; `replace: "block"` replaces that block; `{text}` appends a message | `GPTChat.test.tsx` |
+| Blocks AC20 | Streaming renders completed top-level blocks plus a `Spinner` tail | `parsePartial.test.ts`, `GPTChat.test.tsx` |
+
+## Task List
+
+[`docs/tasks/agent-ui-asks.md`](../tasks/agent-ui-asks.md)
+
+## Acceptance Criteria
+
+| # | Criterion | Verification |
+| --- | --- | --- |
+| AC1 | Every fixture under `blocks/src/asks/fixtures/valid/` passes; every fixture under `invalid/` fails with exactly the expected `{path, code}` pairs (unknown keys, over-limit strings and arrays, duplicate ids, defaults not among options, `minSelected` > `maxSelected`) | `bun test blocks/src/asks` golden test |
+| AC2 | `validateAskResponse` returns a distinct documented code for each answer error: ids not offered, count out of bounds, Other when not allowed, required field missing, wrong field type, out of range, invalid ISO date, text too long, file type not accepted, too large, too many, not owned, MIME mismatch | One test per code; doc-code parity test against `docs/reference/agent-ui-asks.md` |
+| AC3 | With `asks: true`, a mock model that calls `ask_choice` produces SSE `{ask: {toolCallId, kind: "choice", input, simple}}` then `{done: true, historyId, pendingAsk: {toolCallId}}`; `GptHistory.pendingAsk` holds the input, the simple card, and `responseMessages`; the display row has `ask.status: "pending"`; no `{toolCall}` event is sent for it | `ai/src/routes/gpt.test.ts` (supertest) |
+| AC4 | `POST /gpt/prompt {historyId, askResponse: {toolCallId, action: "accept", content: {selected: ["team"]}}}` makes exactly one model call whose messages end with the stored `responseMessages` plus a tool result carrying the answer; SSE starts with `{askResolved}` and ends with `{done}`; `pendingAsk` is cleared and the row shows `answered` | Supertest asserting the mock `doStream` call arguments |
+| AC5 | An invalid answer returns 400 with `fields` and makes no model call; a stale or unknown `toolCallId` returns 409; another user's history returns 403; a `prompt` sent while an ask is pending stores a `cancel` result before the new user message, and the next model call sees both | Supertest |
+| AC6 | A model ask that fails `inputSchema` or semantic rules never reaches the client: the model receives a tool error, and a corrected ask in the next step is the only `{ask}` event | Supertest with a mock model emitting invalid then valid calls |
+| AC7 | `buildMessages` includes ask call/result pairs from completed turns and still skips non-ask tool rows | `ai/src/service/aiService.test.ts` |
+| AC8 | With `asks` unset, the tool set, system prompt, and SSE stream are identical to today | Regression supertest |
+| AC9 | `GPTChat` renders each ask kind with `@terreno/ui` components only; Submit stays disabled until the answer validates; `onAskSubmit` receives `{toolCallId, response}`; server `fields` errors render inline; answered asks render a summary; a pending ask restored from history is interactive | `ui/src/asks/*.test.tsx`, `GPTChat.test.tsx`, `rg` guard test (no raw `View`/`Text` in `ui/src/asks/`) |
+| AC10 | An image answer reaches the model as an `image-data` part and a text file as a text part ≤ 100 KB; a `fileId` owned by another user returns 400 `FILE_NOT_OWNED`; bytes that do not match the declared MIME type return 400 `MIME_MISMATCH`; both storage modes (D5) pass | Supertest + `askFiles.test.ts` |
+| AC11 | HTML: the sanitizer strips scripts, event handlers, forms, frames, `meta`/`base`/`link`, anchor `href`s, and non-`data:image` URLs; oversize → `HTML_TOO_LARGE`; disabled → `HTML_DISABLED`; web renders `<iframe sandbox="">` whose `srcdoc` starts with the CSP meta tag; native renders a WebView with JavaScript off and navigation blocked; streaming shows a placeholder | `sanitizeHtml.test.ts`, `HtmlFrame.test.tsx`, `BlocksView.test.tsx`, demo screenshot |
+| AC12 | example-frontend: a mocked SSE `ask` renders a choice card; selecting an option and submitting posts `askResponse`; the mocked resumed stream renders the continuation | `example-frontend/e2e/ai-chat.spec.ts` + recording under `/opt/cursor/artifacts/` |
+| AC13 | Docs: explanation, reference, and how-to pages exist and are linked from their READMEs; `docs/reference/ai.md` lists every SSE event; `docs/reference/ui.md` documents the ask props | `bun run website:build` + doc-code parity test |
+| AC14 | `bun run prepush` passes (lint, knip, no-barrel-imports, source rules, demo coverage) | CI |
+| AC15 | For every valid fixture, `toSimpleCard` returns a card that passes `simpleCardSchema` (≤ 3 buttons, labels ≤ 20, text ≤ 140), follows the per-kind rule table including `handoff`, and every button's `response` passes `validateAskResponse`; a destructive confirm marks its approve button `destructive` | `blocks/src/asks/simpleCard.test.ts` (golden + property test over all fixtures) |
+| AC16 | With `surface: "compact"`, the model is offered only `ask_confirm` and the narrowed `ask_choice`; a 4-option choice fails as a tool error; the system prompt contains the compact line; every card produced has `handoff: false` | Supertest inspecting the mock model's tools and prompt |
+| AC17 | `GET /gpt/histories/pendingAsks` lists only the caller's pending asks with their cards; `POST /gpt/histories/:id/turn {toolCallId, buttonId}` resumes with that button's stored answer and returns `{text, pendingAsk?}`; an unknown `buttonId` returns 400 `UNKNOWN_BUTTON`; another user's history returns 403; a stale `toolCallId` returns 409; closing the request mid-turn still saves the finished turn | Supertest (the last case aborts the request, then reloads the history) |
+| AC18 | `SimpleAskCard` renders every fixture's card inside the watch-sized demo frame with `@terreno/ui` components only; pressing a button calls `onPress` with that button; `handoff` shows the continue-on-phone line | `ui/src/asks/SimpleAskCard.test.tsx` + demo screenshot under `/opt/cursor/artifacts/` |
+| AC19 | A host tool with `needsApproval: true` never runs before approval: the mock model's call produces an `{ask}` with `kind: "confirm"`, `origin: "approval"` and `execute` is not called; approving (via `/gpt/prompt` or `turn` with `buttonId: approve`) runs it exactly once and the model sees its result; denying, declining, or cancelling never runs it and the model sees the denial | Supertest with a spy `execute` |
+| AC20 | `callout`, `image`, and `details` blocks validate and render with `Banner`, `Image`, and `Accordion` only; `image` requires `alt`; an `https` image whose host is not in `uiBlocks.imageHosts` fails with `IMAGE_HOST_NOT_ALLOWED` while file refs and `data:` URLs pass | `blocks` golden fixtures, `BlocksView.test.tsx`, demo screenshot |