Loading pattern preview
PatternsSDK API
Preliminary Tool Results
Preliminary Tool Results
Return preliminary tool results using async iterables. Stream status updates during tool execution before the final result is available.
Loading pattern preview
Problems solved
Technical challenges this implementation handles out of the box.
- Yield intermediate tool status with async generator execute
- Show progressive tool updates before the final result
- Keep users informed during long-running tool work
Use cases
Products and workflows this pattern is designed to support.
- Weather or lookup tools with staged status
- Long-running enrichment operations
- Progressive tool result UIs
- Teaching async iterable tool execute patterns
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
streamTextconvertToModelMessagestooluseChatProviders
OpenAI
Files added
6 filesapp/page.tsxapp/layout.tsxapp/api/tool-preliminary-results/route.tscomponents/preliminary-results-demo.tsxtools/weather.tstools/weather-ui.tsx
Dependencies
14 totalnpm packages
7AISDKshadcn/uilucide-reactNext.jsReactstreamdownZod
Registry components
alertemptyinput-groupseparatormessage-scrollermessagebubble
Critical files
tools/weather.tsWeather tool demonstrating the preliminary tool results pattern using async generator (async *execute with yield). Yields intermediate status updates before the final result.
Requirements
- Complexity
- Beginner
- Setup time
- ~5 minutes
- Node
- 24+
- Memory
- 512MB
