Interface: ToolCallPart<TMetadata>#

Defined in: packages/ai/src/types.ts:395

Type Parameters#

TMetadata#

TMetadata = unknown

Properties#

approval?#

optional approval?: object;

Defined in: packages/ai/src/types.ts:411

Approval metadata if tool requires user approval

approved?#

optional approved?: boolean;

id#

id: string;

needsApproval#

needsApproval: boolean;

arguments#

arguments: string;

Defined in: packages/ai/src/types.ts:399

id#

id: string;

Defined in: packages/ai/src/types.ts:397

input?#

optional input?: unknown;

Defined in: packages/ai/src/types.ts:408

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.

metadata?#

optional metadata?: TMetadata;

Defined in: packages/ai/src/types.ts:422

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#

name: string;

Defined in: packages/ai/src/types.ts:398

output?#

optional output?: any;

Defined in: packages/ai/src/types.ts:417

Tool execution output (for client tools or after approval)

state#

state: ToolCallState;

Defined in: packages/ai/src/types.ts:409

type#

type: "tool-call";

Defined in: packages/ai/src/types.ts:396