Loading pattern preview
PatternsAgent Patterns
Human in the Loop Plan Builder Agent
Human in the Loop Plan Builder Agent
Uses ToolLoopAgent pattern to gather requirements and generate plans. Generates markdown plans with structured todo lists.
Loading pattern preview
Problems solved
Technical challenges this implementation handles out of the box.
- Gather requirements conversationally before drafting a plan
- Generate markdown plans with structured todo lists
- Refine plans iteratively with user feedback
- Stream ToolLoopAgent plan building through createAgentUIStreamResponse
Use cases
Products and workflows this pattern is designed to support.
- Feature implementation planning
- Migration and upgrade planning
- API integration checklists
- CI/CD setup planning agents
Setup
Requirements, wiring steps, and what this pattern adds to your project.
Getting started
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.
Environment variables
OPENAI_API_KEYGet key
Capabilities
AI SDK APIs
ToolLoopAgenttoolgenerateObjecttoModelOutputhasToolCallstepCountIsuseChatcreateUIMessageStreamstreamTextProviders
OpenAI
Files added
11 filesapp/page.tsxapp/layout.tsxapp/api/plan-builder/route.tslib/ai/plan-builder-agent.tslib/ai/tools/index.tslib/ai/tools/ask-multiple-choice.tslib/ai/tools/ask-text-input.tslib/ai/tools/generate-plan.tslib/ai/tools/refine-plan.tslib/types.tsREADME.md
Dependencies
12 totalnpm packages
7AISDKlucide-reactNext.jsReactsonnerZodstreamdown
Registry components
buttoncollapsibleemptyinputtextarea
Critical files
plan-builder/route.tsAPI route using createAgentUIStreamResponse() with a ToolLoopAgent. Shows the one-line streaming pattern for agent-based endpoints.
ai/plan-builder-agent.tsToolLoopAgent definition with multiple stopWhen conditions including hasToolCall for each HIL tool and stepCountIs(10). Core HIL planning pattern where the agent pauses on tool calls for user input.
tools/ask-multiple-choice.tsGenerator tool using async *execute() with yield for streaming intermediate UI state. Uses nested generateObject to dynamically create contextual questions.
tools/ask-text-input.tsGenerator tool for open-ended text input with yield-based streaming pattern.
tools/generate-plan.tsPlan generation tool using generateObject with planSchema. Demonstrates multi-stage yield for progressive UI updates.
tools/refine-plan.tsPlan refinement tool that takes current plan + feedback, produces updated plan with tracked changes.
lib/types.tsType definitions for the plan builder including Plan, Todo, PlanSection, tool I/O types, and custom UIMessage/DataParts types.
Requirements
- Complexity
- Intermediate
- Setup time
- ~15 minutes
- Node
- 24+
- Memory
- 512MB
