Skip to main content

ToolCallRenderContext

Agent Runtimes


Agent Runtimes / types/chat / ToolCallRenderContext

Interface: ToolCallRenderContext

Defined in: types/chat.ts:54

Tool call render context passed to renderToolResult

Properties

args

args: Record<string, unknown>

Defined in: types/chat.ts:62

Tool arguments (may be incomplete during 'inProgress' status)


error?

optional error?: string

Defined in: types/chat.ts:68

Error message if status is 'error'


name

name: string

Defined in: types/chat.ts:60

Alias for toolName


respond?

optional respond?: RespondCallback

Defined in: types/chat.ts:74

Callback to send response back to the agent (human-in-the-loop). Only available when status is 'executing'. Calling this resolves the tool call with the provided result.


result?

optional result?: unknown

Defined in: types/chat.ts:64

Tool result (only available when status is 'complete')


status

status: DisplayToolCallStatus

Defined in: types/chat.ts:66

Tool call status


toolCallId

toolCallId: string

Defined in: types/chat.ts:56

Tool call ID


toolName

toolName: string

Defined in: types/chat.ts:58

Tool name (e.g., "get_weather")