Loading pattern preview
BlocksHuman-in-the-Loop
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
Compare with
Similar patterns, and when each one is the better fit.
Marketing Plan & Implement AgentUse this when your agent must capture brand details from a URL or form, get a todo plan approved, then carry it out with scraping and research tools.
Just Bash Skills AgentUse this when an ops or on-call assistant should load markdown runbooks and checklists from disk as skills, using only a skill tool and readFile.
Multi-Step Tool PatternUse this when a chat agent must call several typed tools in a row, feeding each result into the next step, with a step limit to stop runaway loops.
PlanUse this when your chat agent produces step-by-step plans and you want them streamed into a collapsible plan component with shimmer while steps load.
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
Download → Next.js app
Use Download → Next.js app in the preview toolbar. You get a zip scaffold (Pro downloads rewrite preview `/view/.../api/*` paths to `/api/*` automatically).
- 2
Extract the zip and install dependencies
Unzip the archive, then run `pnpm install` (or npm / yarn) in the project folder.
- 3
Fill .env.local
The download includes .env.local placeholders when needed. Add real values for: OPENAI_API_KEY.
- 4
Customize the agent and tool files
Adapt prompts, tools, and stop conditions in the generated project for your product.
- 5
Run the app and open the pattern route
Run `pnpm dev`, open the setup/checklist page if present, then navigate to the generated pattern route and verify responses.
Environment variables
OPENAI_API_KEYGet key
Capabilities
AI SDK APIs
ToolLoopAgenttoolgenerateObjecttoModelOutputhasToolCallstepCountIsuseChatcreateUIMessageStreamstreamTextInferAgentUIMessagegatewayProviders
OpenAI
Files added
11 files
app/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
14 total
npm packages
8AISDKlucide-reactNext.jsReactsonnerZodstreamdownuse-stick-to-bottom
Registry components
buttoncollapsibleemptyinputtextareatooltip
Critical files
7 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
