Defined in: packages/ai/src/types.ts:508
TMetadata = unknown
optional approval?: object;Defined in: packages/ai/src/types.ts:524
Approval metadata if tool requires user approval
optional approved?: boolean;id: string;needsApproval: boolean;arguments: string;Defined in: packages/ai/src/types.ts:512
id: string;Defined in: packages/ai/src/types.ts:510
optional input?: unknown;Defined in: packages/ai/src/types.ts:521
Parsed tool input. Set from the parsed arguments once they are complete (state: 'input-complete' and later). undefined while the raw arguments string is still streaming, and may stay undefined for a call that terminates in an error state — the raw arguments string is always available as a fallback. Typed per-tool on the client ToolCallPart (see @tanstack/ai-client); unknown on this base type.
optional metadata?: TMetadata;Defined in: packages/ai/src/types.ts:541
Provider-specific metadata that round-trips with the tool call. Typed per-adapter via TToolCallMetadata. May follow the ProviderExecutedToolMetadata convention to mark provider-executed server tools (e.g. Anthropic web_search).
name: string;Defined in: packages/ai/src/types.ts:511
optional output?: any;Defined in: packages/ai/src/types.ts:530
Tool execution output (for client tools or after approval)
optional resultMetadata?: unknown;Defined in: packages/ai/src/types.ts:536
App-only metadata that the tool set with setResultMetadata. The model never sees it. Typed per tool on the client ToolCallPart (see @tanstack/ai-client); unknown on this base type.
state: ToolCallState;Defined in: packages/ai/src/types.ts:522
type: "tool-call";Defined in: packages/ai/src/types.ts:509