Trait Tool 

pub trait Tool:
    Sized
    + WasmCompatSend
    + WasmCompatSync {
    type Args: for<'de> Deserialize<'de> + WasmCompatSend + WasmCompatSync;
    type Output: IntoToolOutput;
    type Error: Error + WasmCompatSend + WasmCompatSync + 'static;

    const NAME: &'static str;

    // Required methods
    fn description(&self) -> String;
    fn parameters(&self) -> Value;
    fn call(
        &self,
        context: &mut ToolContext,
        args: Self::Args,
    ) -> impl Future<Output = Result<Self::Output, Self::Error>> + WasmCompatSend;

    // Provided method
    fn map_error(&self, error: Self::Error) -> ToolExecutionError { ... }
}

A typed LLM tool.

Tool authors provide metadata and exactly one execution method. Runtime context and host-only result metadata share the ToolContext path. Rig’s object-safe dispatch boundary is private; use DynamicTool when the tool name or callback is only known at runtime.

Required Associated Constants

const NAME: &'static str

Unique registration and provider-facing name.

Required Associated Types

type Args: for<'de> Deserialize<'de> + WasmCompatSend + WasmCompatSync

Typed JSON arguments.

type Output: IntoToolOutput

Output convertible into Rig’s canonical model presentation.

Every owned serializable value implements IntoToolOutput automatically. ToolResultContent and OneOrMany preserve rich content when returned directly; use ToolOutput when constructing the presentation explicitly.

type Error: Error + WasmCompatSend + WasmCompatSync + 'static

Typed error returned by direct calls to this tool.

Rig normalizes this error into ToolExecutionError only at the erased dispatch boundary. This keeps ordinary ? propagation and typed unit tests available to tool authors without creating a second runtime error representation.

Required Methods

fn description(&self) -> String

Model-facing description.

fn parameters(&self) -> Value

JSON Schema for arguments.

fn call( &self, context: &mut ToolContext, args: Self::Args, ) -> impl Future<Output = Result<Self::Output, Self::Error>> + WasmCompatSend

Execute the tool.

Provided Methods

fn map_error(&self, error: Self::Error) -> ToolExecutionError

Normalize a typed author-facing error for runtime policy and telemetry.

The default preserves the concrete source and classifies it as crate::tool::ToolErrorKind::Other. Override this method when the domain error can provide a more precise kind, retryability policy, or safe model output.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Tool for MockAddTool

Available on crate feature test-utils only.

const NAME: &'static str = "add"

type Error = MockToolError

type Args = MockOperationArgs

type Output = i32

impl Tool for MockBarrierTool

Available on crate feature test-utils only.

const NAME: &'static str = "barrier_tool"

type Error = MockToolError

type Args = Value

type Output = String

impl Tool for MockContextProbeTool

Available on crate feature test-utils only.

const NAME: &'static str = "context_probe"

type Error = ToolExecutionError

type Args = Value

type Output = String

impl Tool for MockControlledTool

Available on crate feature test-utils only.

const NAME: &'static str = "controlled"

type Error = MockToolError

type Args = Value

type Output = i32

impl Tool for MockDeniedTool

Available on crate feature test-utils only.

const NAME: &'static str = "guarded"

type Error = MockToolError

type Args = Value

type Output = String

impl Tool for MockExampleTool

Available on crate feature test-utils only.

const NAME: &'static str = "example_tool"

type Error = MockToolError

type Args = ()

type Output = String

impl Tool for MockFailingTool

Available on crate feature test-utils only.

const NAME: &'static str = "flaky_tool"

type Error = MockFailure

type Args = Value

type Output = String

impl Tool for MockHandledFailureTool

Available on crate feature test-utils only.

const NAME: &'static str = "lookup"

type Error = MockToolError

type Args = Value

type Output = String

impl Tool for MockImageGeneratorTool

Available on crate feature test-utils only.

const NAME: &'static str = "generate_test_image"

type Error = MockToolError

type Args = Value

type Output = ToolOutput

impl Tool for MockImageOutputTool

Available on crate feature test-utils only.

const NAME: &'static str = "image_output"

type Error = MockToolError

type Args = Value

type Output = ToolOutput

impl Tool for MockMetadataTool

Available on crate feature test-utils only.

const NAME: &'static str = "with_meta"

type Error = MockToolError

type Args = Value

type Output = String

impl Tool for MockObjectOutputTool

Available on crate feature test-utils only.

const NAME: &'static str = "object_output"

type Error = MockToolError

type Args = Value

type Output = Value

impl Tool for MockStringOutputTool

Available on crate feature test-utils only.

const NAME: &'static str = "string_output"

type Error = MockToolError

type Args = Value

type Output = String

impl Tool for MockSubtractTool

Available on crate feature test-utils only.

const NAME: &'static str = "subtract"

type Error = MockToolError

type Args = MockOperationArgs

type Output = i32

impl<T> Tool for T

where T: PortableTool,

const NAME: &'static str = <T as rig_core::tool::PortableTool>::NAME

type Args = <T as PortableTool>::Args

type Output = <T as PortableTool>::Output

type Error = <T as PortableTool>::Error