Enum ToolDefinition 

pub enum ToolDefinition {
    Builtin(BuiltinTool),
    ClientSide(ClientSideTool),
}

Tool definition in agent configuration

Variants

Builtin(BuiltinTool)

Built-in tool - executed by the worker via ToolRegistry

ClientSide(ClientSideTool)

Client-side tool - executed by the client, not the server

Implementations

impl ToolDefinition

pub fn name(&self) -> &str

Get the tool name regardless of variant

pub fn display_name(&self) -> Option<&str>

Get the tool display name regardless of variant

pub fn description(&self) -> &str

Get the tool description regardless of variant

pub fn parameters(&self) -> &Value

Get the tool parameters schema regardless of variant

pub fn full_parameters(&self) -> &Value

Get the full (pre-deferral) parameter schema, falling back to parameters().

When DeferSchemaHook strips a tool’s schema it saves the original in full_parameters. Callers that need the real schema (e.g. tool_search) should use this method so deferred tools still return useful results.

pub fn policy(&self) -> &ToolPolicy

Get the tool policy regardless of variant

pub fn category(&self) -> Option<&str>

Get the tool category for namespace grouping

pub fn deferrable(&self) -> &DeferrablePolicy

Get the deferrable policy for tool_search

pub fn hints(&self) -> &ToolHints

Get the tool hints

pub fn concurrency_class(&self) -> Option<&str>

Scheduling conflict key for this tool, if any (see ToolHints::concurrency_class). None means the tool has no mutation conflicts and may always run concurrently with others.

pub fn is_cpu_bound(&self) -> bool

Whether this tool performs CPU-bound/non-yielding in-process work and should be offloaded to its own task by the act scheduler.

pub fn side_effect_class(&self) -> SideEffectClass

Effective side-effect class for this tool (defaults to AtMostOnce).

pub fn capability_attribution(&self) -> Option<(&str, Option<&str>)>

Get reporting attribution for the capability that contributed this tool.

pub fn with_category(self, category: impl Into<String>) -> ToolDefinition

Set the category on this tool definition (builder pattern)

pub fn with_hints(self, hints: ToolHints) -> ToolDefinition

Set the hints on this tool definition (builder pattern)

pub fn with_capability_attribution( self, capability_id: impl Into<String>, capability_name: Option<impl Into<String>>, ) -> ToolDefinition

Set reporting attribution on this tool definition (builder pattern).

pub fn with_human_intent_argument(self) -> ToolDefinition

Add the cross-cutting human_intent argument to the tool’s JSON schema.

This field is model-authored narration for UI rendering. Tool execution strips it before invoking the underlying tool implementation.

Trait Implementations

impl Clone for ToolDefinition

fn clone(&self) -> ToolDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolDefinition

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToolDefinition, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ToolDefinition> for ToolDefinitionSummary

fn from(tool: &ToolDefinition) -> Self

Converts to this type from the input type.

impl Serialize for ToolDefinition

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.