Plan

A collapsible plan component for displaying AI-generated execution plans with streaming support and shimmer animations.

Loading preview…

Problems solved

Technical challenges this implementation handles out of the box.

Products and workflows this pattern is designed to support.

Requirements, wiring steps, and what this pattern adds to your project.

Pick how you want to pull this pattern in. Then wire env vars and routes the same way.

1
Install from the preview toolbar
Copy the install command above and run it in your project — Pro patterns include a short-lived token.
2
Add environment variables to .env.local
OPENAI_API_KEY
3
Point client fetches at your API routes
Replace preview `/view/.../api/...` paths with `/api/...` in the installed files.
4
Customize the agent and tool files
Adapt prompts, tools, and stop conditions for your product — Copy for AI in the toolbar helps seed that work.
5
Run your dev server and open the pattern route
Install dependencies if needed, then start the app and verify responses.

AI SDK APIs

ToolLoopAgentcreateUIMessageStreamcreateUIMessageStreamResponseconvertToModelMessagesvalidateUIMessagesstreamTexttoolgateway

Providers

OpenAI

7 files

8 total

npm packages

AISDKlucide-reactNext.jsReact

Registry components

cardcollapsiblebuttonempty

plan/route.ts
API route for the plan agent. Uses createUIMessageStream with custom PlanUIMessage type. Implements convertDataPart to transform plan data parts back into text so the model can see and edit existing plans. Extracts generatePlan tool output on finish to write structured data-plan-info parts.
lib/plan-agent.ts
Defines the ToolLoopAgent for plan generation. Configures 5 tools (generatePlan, executeStep, updatePlan, reviewPlan, buildPlan) with detailed workflow instructions. Uses stepCountIs(20) stop condition.
tools/plan-generator.ts
Implements 5 generator-based plan tools using async *execute pattern for progressive streaming. Each tool uses nested streamText calls for AI-powered content generation.

Loading preview…