v8.0.1 · Interface

tools

Tool calls, plans, and permission requests. Tool calls are resource-shaped: the agent constructs a [`tool-call`] when it starts dispatching, applies `update`s as the call progresses, and drops it when the call ends. The tool-call's state is mirrored to the surrounding [`agent.prompt-turn`]'s `updates` stream as `session-update::ToolCall` / `session-update::ToolCallUpdate` entries — guests don't write those variants directly. See:

Resources

An active tool call. Construct with [<code>tool-call.constructor</code>]

Records

A diff against a single file.

tool-call-location

A file location a tool call is operating on.

Initial state used to construct a [<code>tool-call</code>].

tool-call-patch

A patch to apply to an active [<code>tool-call</code>]. Each field is

tool-call-snapshot

permission-option

request-permission-request

request-permission-response

Variants

tool-call-content

Output produced by a tool call.

permission-outcome

Enums

Categories of tools.

tool-call-status

Lifecycle states of a tool call.

plan-entry-priority

plan-entry-status

permission-option-kind

Type Aliases

A displayable block of content.

Unique identifier for a terminal created via <code>create-terminal</code>.

Unique identifier for a tool call within a session. Used in