tool( )
Pattern
BEG·Nov 25

Preliminary Tool Results

Return preliminary tool results using async iterables. Stream status updates during tool execution before the final result is available.

View Full Pattern on Desktop
Preliminary Tool Results preview

Problems Solved

  • Stream preliminary tool results during execution
  • Provide status updates before final result
  • Use async iterables for progressive tool results
  • Display intermediate states during tool execution

Use Cases

  • Streaming tool execution status
  • Progressive tool result updates
  • Long-running tool operations
  • Understanding async generator tool patterns

AI SDK APIs

streamTextconvertToModelMessagestool(useChatasync-generator

Tags

aitoolspreliminary-resultsasync-iterablesgenerator-functionsstreamingai-sdktool-api

Requirements

Node.js
24+
Memory
512MB
Other
  • OpenAI API key

Environment Variables

External Services

openai

Ready to use?

View the full interactive pattern with live preview and copy the source code.

View Pattern on Desktop

Related Patterns

Tool Input Lifecycle Hooks preview

Tool Input Lifecycle Hooks

Explore tool input lifecycle hooks: onInputStart, onInputDelta, and onInputAvailable. See how to track tool input generation in real-time during streaming.

aitools+7
View →
Tool API Context preview

Tool API Context

Pass arbitrary context from generateText/streamText to tool execution via experimental_context. Access context in tool execute functions for dynamic behavior.

aitools+5
View →
Tool Call Repair preview

Tool Call Repair

Repair invalid tool calls using experimental_repairToolCall. Fix schema validation errors without requiring additional steps that pollute message history.

aitools+6
View →
Dynamic Tool preview

Dynamic Tool

Create dynamic tools with runtime-generated schemas using dynamicTool. Demonstrates unit conversion tools where schema adapts based on conversion type (temperature, length, weight, currency) and supports dynamic model selection.

aitools+8
View →
End of Pattern