Class ToolCallHook

A tool about to run. ask(reason) asks a person whether it may run.

Hierarchy

HookEvent
- ToolCallHook

Index

Constructors

Properties

approval effects function id input invocation name path settings

Methods

ask entries remember

Constructors

constructor

new ToolCallHook(
    approval: Approval,
    fn: string,
    settings: Rec,
    call: Call,
): ToolCallHook
Parameters
- approval: Approval
- fn: string
- settings: Rec
- call: Call
Returns ToolCallHook
Overrides HookEvent.constructor
- Defined in src/plugins.ts:437

Properties

`Readonly`approval

approval: Approval

What a person would be shown.

`Readonly`effects

effects: "reads" | "changes" | null

`Readonly`function

function: string

The AI function that asked for it.

`Readonly`id

id: string

input

input: unknown

Its input, as the changes before this handler left it.

`Readonly`invocation

invocation: number

`Readonly`name

name: string

`Readonly`path

path: string

support/answer/refund.

`Readonly`settings

settings: Rec

The asking call's settings (its approve among them).

Methods

ask

ask(
reason?: string | null,
opts?: { decide?: ApproveFunction | null },
): Promise<boolean>
Ask a person whether the tool may run: in a conversation the turn waits, saved, and goes on when someone answers; on a stream the call waits for s.approve(); a plain call refuses (approval-required). decide answers in place of a person. Resolves true, or false (the person's refusal is then the result the model sees).
Parameters
- Optionalreason: string | null
- opts: { decide?: ApproveFunction | null } = {}
Returns Promise<boolean>
- Defined in src/plugins.ts:458

entries

entries(kind: string): Rec[]
This plugin's entries of a kind on the branch of the turn the call runs in ([] outside a conversation).
Parameters
- kind: string
Returns Rec[]
Inherited from HookEvent.entries
- Defined in src/plugins.ts:243

remember

remember(kind: string, data: unknown): Promise<void>
Keep an entry of this plugin at the turn the call runs in (outside a conversation, a TypeError).
Parameters
- kind: string
- data: unknown
Returns Promise<void>
Inherited from HookEvent.remember
- Defined in src/plugins.ts:249