Interface: ToolCallPart<TMetadata>#

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

Type Parameters#

TMetadata#

TMetadata = unknown

Properties#

approval?#

optional approval: object;

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

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:374

id#

id: string;

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

metadata?#

optional metadata: TMetadata;

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

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:373

output?#

optional output: any;

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

Tool execution output (for client tools or after approval)

state#

state: ToolCallState;

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

type#

type: "tool-call";

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