tool( )

Pattern

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.

BeginnerNov 2025View the full pattern on desktop
Tool Input Lifecycle Hooks preview

Problems solved

  • Track tool input generation in real-time
  • Monitor tool input streaming with lifecycle hooks
  • Understand tool input lifecycle events
  • Debug tool input generation process

Use cases

  • Learning tool input lifecycle hooks
  • Debugging tool input generation
  • Monitoring tool input streaming
  • Understanding AI SDK tool APIs

AI SDK APIs

streamTextconvertToModelMessagestool(useChatonInputStartonInputDeltaonInputAvailable

Tags

aitoolslifecycle-hooksonInputStartonInputDeltaonInputAvailablestreamingai-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 the pattern on desktop

Related patterns

Preliminary Tool Results preview

Preliminary Tool Results

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

aitools+6
View pattern →
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 pattern →
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 pattern →
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 pattern →

You’ve reached the end of this pattern.