tool-ui-documenter

An agent for documenting Tool UI components and connecting their pages, examples, metadata, and preview registries.

In plain words
What is it for?
Use it after implementation and preset creation to add the docs page, usage examples, component metadata, previews, and accessibility notes.
Why use it?
It prevents a component from being implemented without usable documentation or appearing in the project’s documentation surfaces.

Agent for Claude Code

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add agents/assistant-ui/tool-ui/tool-ui-documenter
Clone the repo
git clone --depth 1 https://github.com/assistant-ui/tool-ui

Made for: Claude Code.

Per session 30 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 404 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00030 $0.00404
Opus 5 $0.00015 $0.00202
Sonnet 5 $0.00006 $0.00081
Haiku 4.5 $0.00003 $0.00040

Measured 2d ago against content hash 4953000c92eb, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

tool-ui-documenter scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/agents/tool-ui-documenter.md · 60 lines

What it actually says

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)
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 60 lines · 30 tokens per session scan A 4953000c92eb

Subscribe to this mod's changes

tool-ui-documenter is an agent published in the GitHub repository assistant-ui/tool-ui (773 stars, last pushed 3mo ago), licensed MIT. It adds 30 tokens to every session and 404 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other agents, from other repositories

Accessibility Expert

Expert assistant for web accessibility (WCAG 2.1/2.2), inclusive UX, and a11y testing.

Polydile/dile-components · 28 tokens

react-frontend

Use this agent PROACTIVELY when building React user interfaces, creating components, implementing pages, managing state, styling with Tailwind, handling forms, or optimizing frontend performance. Invoke for any React 19+, Next.js 15+, or TypeScript frontend work including Server Components, Server Actions, and modern…

lando-labs/cami · 68 tokens

style-migrator

Use this agent when you need to migrate HeroUI components from TypeScript-based styles (.styles.ts files using tailwind-variants) to CSS-based styles (.css files) following the BEM naming convention. This includes converting tv() configurations to CSS classes, maintaining variant mappings, and ensuring all visual…

heroui-inc/heroui · 0 tokens

storybook-debugger

Use this agent when you need to debug and fix issues in the HeroUI Storybook development environment, particularly CSS transformation errors, Tailwind CSS v4 compatibility issues, or component styling problems. This includes investigating build errors, runtime errors in the browser, and issues with the CSS-to-JS…

heroui-inc/heroui · 0 tokens

component-example-researcher

Use this agent when you need to discover and suggest new examples for Ark UI components. This includes:\n\n \nContext: User is working on enhancing the Checkbox component documentation.\nuser: "I've just finished updating the Checkbox component API. Can you help me find what examples we should add?"\nassistant: "I'll…

chakra-ui/ark · 0 tokens

Update Copilot CompletionAlgorithm

Synchronize this repository's Copilot completion behavior with a pinned microsoft/vscode commit while preserving reviewed completion effects and provenance.

smallmain/vscode-unify-chat-provider · 30 tokens