Tool UI

Tool UI

Use this skill to move from request to working Tool UI integration quickly.

Prefer assistant-ui when the project has no existing chat UI/runtime. Treat assistant-ui as optional when the app already has a working runtime.

Workflow

1. Run compatibility and doctor checks.
2. Find candidate components or bundles.
3. Install selected components.
4. Generate scaffolds and integrate runtime wiring.
5. Validate behavior and troubleshoot failures.

Step 1: Compatibility and Doctor

python scripts/tool_ui_compat.py --project <repo-root>
python scripts/tool_ui_compat.py --project <repo-root> --doctor

Auto-fix missing @tool-ui registry entry:

python scripts/tool_ui_compat.py --project <repo-root> --fix

Minimum requirements:

• components.json exists.
• components.json.aliases.utils exists (typically @/lib/utils).
• components.json.registries["@tool-ui"] equals https://tool-ui.com/r/{name}.json.

Step 2: Discover Components

Use intent-first discovery:

python scripts/tool_ui_components.py list
python scripts/tool_ui_components.py find "<use case keywords>"
python scripts/tool_ui_components.py bundle
python scripts/tool_ui_components.py bundle planning-flow

References:

• references/components-catalog.md
• references/recipes.md

Step 3: Install Components

Generate install command:

python scripts/tool_ui_components.py install <component-id> [component-id...]

Default install pattern:

npx shadcn@latest add https://tool-ui.com/r/<component-id>.json

Step 4: Scaffold and Integrate

Generate wiring snippet:

python scripts/tool_ui_scaffold.py --mode assistant-backend --component plan
python scripts/tool_ui_scaffold.py --mode assistant-frontend --component option-list
python scripts/tool_ui_scaffold.py --mode manual --component stats-display

Use integration patterns for final adaptation:

• references/integration-patterns.md

Step 5: Validate and Troubleshoot

After integration:

1. Run typecheck/lint.
2. Trigger a real tool call.
3. Confirm UI renders and interactions complete expected flow.

If broken, use:

• references/troubleshooting.md

Operational Rules

• Install the smallest set of components that solves the request.
• Validate one component first, then scale to multiple components.
• Keep payload schemas serializable and explicit.
• For interactive flows, ensure addResult(...) is called from user action callbacks.

Maintainer Notes

Keep component metadata synchronized with Tool UI source:

python scripts/sync_components.py

Run script tests:

python -m unittest discover -s tests -p "test_*.py"