Skip to main content

Module tools

Module tools 

Source

Structs§

PendingCompletion
Configuration carried by a ToolResult::Pending result: how long the runtime waits for the deferred outcome, and what to do if it times out or is cancelled.
PreparedToolCall
Runtime-prepared executable tool call.
StaticToolProvider
Author a fixed-tool provider without hand-rolling tool_manifests / resolve_contract: supply the ToolDefinitions once and an StaticToolExecute for behavior. A ToolProvider that serves a fixed set of ToolDefinitions from a cache, delegating execution to an StaticToolExecute.
ToolAvailabilityConfig
ToolCall
Per-call inputs handed to ToolProvider::execute.
ToolCallOutput
ToolCallRecord
ToolContext
Per-call environment for ToolProvider::execute. Fields are sealed so the runtime can add capabilities without breaking tool authors.
ToolContract
Heavy tool contract resolved only when a prompt or call needs schemas/docs.
ToolDefinition
Static authoring helper for tools.
ToolDurableEffects
Durable effect operations available to advanced in-process tools.
ToolManifest
Tool metadata exposed to prompts, catalogs, UI, and availability checks. The optional compact contract is the catalog-facing projection of the resolved contract; full schemas stay in ToolContract.
ToolPrepareCall
Inputs handed to ToolProvider::prepare_tool_call.
ToolPrepareContext
ToolRestoreReport
Outcome of ToolRegistry::restore_state: the adopted generation plus the ids of persisted tools that no registered source currently resolves. Hosts should surface a non-empty orphaned list to the user — the session opened, but those tools are Off until their source returns.
ToolSourceHandle
ToolState
ToolStateEntry
ToolTriggerClient

Enums§

CancelHint
What a pending tool call signals about its out-of-band work when cancelled.
TimeoutBehavior
What a pending tool call does when its deadline elapses.
ToolActivation
ToolArgumentProjectionPolicy
ToolAvailability
ToolOutputContract
ToolResult
The outcome a ToolProvider::execute returns for a single call.
ToolScheduling
How a tool’s invocations should be scheduled relative to other tools in the same batch of model-produced tool calls.

Traits§

StaticToolExecute
Author a fixed-tool provider without hand-rolling tool_manifests / resolve_contract: supply the ToolDefinitions once and an StaticToolExecute for behavior. Per-call execution behavior for a StaticToolProvider.
ToolProvider
Trait for providing tools to the sandbox. Implement this per-project.