Struct ToolBuilder 

pub struct ToolBuilder { /* private fields */ }

Builder for ergonomic toolkit tool declarations. The builder requires an explicit effect and risk class before it can produce a Tool or AsyncTool.

Implementations

impl ToolBuilder

pub fn new( tool_name: impl Into<String>, executor_ref: impl Into<String>, schema_id: impl Into<String>, policy_ref: PolicyRef, ) -> Self

Creates a new data-only tool declaration builder.

pub fn read_only(self) -> Self

Marks this declaration as a read-like tool.

pub fn write_effect(self) -> Self

Marks this declaration as a write-like tool.

pub fn effect(self, effect_class: EffectClass, risk_class: RiskClass) -> Self

Sets an explicit effect and risk class.

pub fn capability_id(self, capability_id: CapabilityId) -> Self

Sets the stable capability id used by the runtime package.

pub fn namespace(self, namespace: CapabilityNamespace) -> Self

Sets the capability namespace.

pub fn required_permission(self, permission: CapabilityPermission) -> Self

Adds a required permission to the provider-visible tool snapshot.

pub fn redacted_schema(self, schema: Value) -> Self

Attaches a provider-safe JSON schema body to this tool declaration.

pub fn description(self, description: impl Into<String>) -> Self

Attaches a bounded provider-visible description to this declaration.

pub fn description_opt(self, description: Option<String>) -> Self

Attaches a provider-visible description when one is present.

pub fn policy_ref(self, policy_ref: PolicyRef) -> Self

Adds another policy ref that must travel with the tool declaration.

pub fn require_approval(self) -> Self

Requires host approval before the core runtime releases the executor.

pub fn redaction_policy(self, policy_ref: PolicyRef) -> Self

Sets the redaction policy ref for tool results.

pub fn timeout_ms(self, timeout_ms: u64) -> Self

Sets the execution timeout metadata.

pub fn cancellation(self, cancellation: impl Into<String>) -> Self

Sets the cancellation metadata.

pub fn reconciliation(self, reconciliation: impl Into<String>) -> Self

Sets the reconciliation metadata.

pub fn privacy(self, privacy: PrivacyClass) -> Self

Sets the privacy class used for the tool snapshot and route.

pub fn async_mode(self) -> Self

Marks the declaration as async metadata.

pub fn build(self) -> Result<Tool, AgentError>

Builds a synchronous tool declaration.

pub fn build_async(self) -> Result<AsyncTool, AgentError>

Builds an async tool declaration.

Trait Implementations

impl Clone for ToolBuilder

fn clone(&self) -> ToolBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToolBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.