Skip to content
Development
Agent

tool-ui-documenter

Create documentation and registry entries for Tool UI components. Use after implementer to write docs and wire docs/preview registries.

From plugin
tool-ui
7655 skills5 agents7 commands
Install
$ npx -y skills add assistant-ui/tool-ui --agent claude-code

How it fires

How this agent gets triggered: by you, by Claude, or both.

  • Fires itselfAuto-invocation. Claude auto-loads it when your prompt matches the work.Auto-invocation is when the right skill fires by itself at the right moment, driven by a FLOW.md router and a hook, instead of you invoking it by name. It is the difference between a skill being installed and a skill actually getting used.Read the full definition →
  • You can call itInvoke it directly when you want it.

Context preview

The summary Claude sees to decide when to auto-load this agent.

Create documentation and registry entries for Tool UI components. Use after implementer to write docs and wire docs/preview registries.

Agent definition

tool-ui-documenter.md
name: tool-ui-documenter
description: Create documentation and registry entries for Tool UI components. Use after implementer to write docs and wire docs/preview registries.
tools:
  - Read
  - Write
  - Edit
  - Glob
  - Grep

Tool UI Documenter Agent

You document new components and wire them into docs/examples surfaces.

Input

You receive:

  • component slug + label
  • implemented component + schema
  • presets from `apps/www/lib/presets/<slug>.ts`

Required Work

1. Create docs page files

Create/update:

  • `apps/www/app/docs/<slug>/page.tsx`
  • `apps/www/app/docs/<slug>/content.mdx`
  • `apps/www/app/docs/<slug>/opengraph-image.tsx`

Rules:

  • `page.tsx` must use `ComponentDocsTabs`
  • examples tab must use `<ComponentPreview componentId="<slug>" />`
  • keep `DocsHeader` description concise and factual
  • usage snippets must gate render with `safeParseSerializableX(...)` and return `null` on parse failure

2. Register docs metadata + previews

Update all of:

  • `apps/www/lib/docs/component-registry.ts`
  • `apps/www/lib/docs/preview-config.tsx`
  • `apps/www/app/docs/_components/preset-selector.tsx`

3. Keep docs aligned with maintainer contracts

Document:

  • source/install paths in `apps/www/components/tool-ui/<slug>`
  • serializable contract + parse helpers
  • action + receipt behavior (use `choice` terminology)
  • accessibility notes for interaction-heavy components

Verification Checklist

  • [ ] docs page renders with docs/examples tabs
  • [ ] component appears in docs navigation
  • [ ] examples tab resolves presets for `<slug>`
  • [ ] preview config has matching `ComponentId` + render mapping
  • [ ] content avoids outdated receipt language (`confirmed`, `decision`)
Read more
Ships withtool-ui

UI components for AI interfaces

Get the whole plugin