Enum Tool 

pub enum Tool {
    Custom(CustomTool),
    Builtin(BuiltinTool),
}

A tool definition the model can call during generation.

The wire form is untagged: custom tools are recognized by the presence of an input_schema field; anything else is treated as a built-in tool.

Variants

Custom(CustomTool)

A user-defined tool with a JSON Schema for input validation.

Builtin(BuiltinTool)

A server-side built-in tool (web search, computer use, code execution, etc.). Typed via KnownBuiltinTool with an Other(Value) arm for forward-compatibility with new tools / new tool versions.

Implementations

impl Tool

pub fn custom(name: impl Into<String>, input_schema: Value) -> Self

Convenience constructor for a custom tool with a manually provided JSON Schema.

pub fn builtin(value: Value) -> Self

Escape hatch: build a Tool::Builtin from raw JSON. Use the typed constructors (Self::web_search, Self::computer, Self::bash, Self::text_editor, Self::code_execution) instead when the tool type is known to the SDK; this is for unknown / future tools.

use claude_api::messages::tools::Tool;
// Unknown future tool -- round-trips through Builtin::Other.
let t = Tool::builtin(serde_json::json!({
    "type": "future_tool_2099",
    "name": "future"
}));
assert!(matches!(t, Tool::Builtin(_)));

pub fn web_search() -> Self

Default-config web search tool (web_search_20250305).

pub fn computer(display_width_px: u32, display_height_px: u32) -> Self

Computer-use tool with the given display dimensions (computer_20250124).

pub fn bash() -> Self

Default-config bash tool (bash_20250124).

pub fn text_editor() -> Self

Default-config text editor tool (text_editor_20250124).

pub fn code_execution() -> Self

Default-config code execution tool (code_execution_20250825).

pub fn from_schemars<T: JsonSchema>(name: impl Into<String>) -> Self

Available on crate feature schemars-tools only.

Build a custom tool whose input schema is derived from a Rust type via schemars.

Panics

Panics only if the generated RootSchema fails to JSON-serialize, which schemars guarantees not to happen for any type that implements schemars::JsonSchema.

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Tool

fn eq(&self, other: &Tool) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Tool

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Tool