Skip to main content

ToolRenderAndWaitProps

Agent Runtimes

Agent Runtimes / types/tools / ToolRenderAndWaitProps

Interface: ToolRenderAndWaitProps<TArgs, TResult>

Defined in: src/types/tools.ts:147

Props passed to renderAndWaitForResponse (HITL pattern)

Extends​

Type Parameters​

TArgs​

TArgs = Record<string, unknown>

TResult​

TResult = unknown

Properties​

args​

args: TArgs

Defined in: src/types/tools.ts:135

Tool arguments from the LLM

Inherited from​

ToolRenderProps.args

error?​

optional error?: string

Defined in: src/types/tools.ts:141

Error message (only when status is 'failed')

Inherited from​

ToolRenderProps.error

respond​

respond: (result) => Promise<void>

Defined in: src/types/tools.ts:152

Call this to respond with a result (for HITL approval)

Parameters​

result​

TResult

Returns​

Promise<void>

result?​

optional result?: TResult

Defined in: src/types/tools.ts:138

Result after execution (only when status is 'complete')

Inherited from​

ToolRenderProps.result

status​

status: ToolRenderStatus

Defined in: src/types/tools.ts:132

Current execution status

Inherited from​

ToolRenderProps.status