tool( )

Pattern

Tool API Context

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

BeginnerNov 2025View the full pattern on desktop
Tool API Context preview

Problems solved

  • Pass arbitrary context to tool execution
  • Dynamic tool behavior based on context
  • Access context in tool execute functions
  • Customize tool behavior without modifying tool definition

Use cases

  • Passing user preferences to tools
  • Dynamic API key management
  • Context-aware tool behavior
  • User-specific tool customization

AI SDK APIs

streamTextconvertToModelMessagestool(useChatexperimental_context

Tags

aitoolsexperimental-contextcontextdynamic-behaviorai-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

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 pattern →
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 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.