ToolCall
An agent tool invocation with arguments, execution status, and optional result or error.
import type { ToolCall } from '@threadplane/chat';Declaration
export interface ToolCall {
args: unknown;
error?: unknown;
id: string;
name: string;
parts?: readonly unknown[];
result?: unknown;
status: ToolCallStatus;
}Members
args
Arguments. May be partial while streaming (status !== 'complete').
args: unknown;error
Optional error payload when status === 'error'.
error?: unknown;id
id: string;name
name: string;parts
Structured result parts when the runtime returned them (AG-UI 1.0
ContentPart[]). result then holds the text, parsed as JSON only when a
single text part holds valid JSON (several text parts are joined
unparsed); it may be empty for an all-media result. Runtime-specific shape.
parts?: readonly unknown[];result
Present when status === 'complete' or 'error'.
result?: unknown;status
status: ToolCallStatus;