Skip to main content

ToolDefinition

Enum ToolDefinition 

Source
pub enum ToolDefinition {
    Custom(CustomTool),
    Server(Value),
}
Expand description

Tool definition – either a custom client tool or a built-in server tool.

Use this type in MessagesRequest::tools.

§Variants

§Example

use claude_sdk::{CustomTool, ToolDefinition};
use serde_json::json;

// Custom tool
let custom = ToolDefinition::Custom(
    CustomTool::new("my_tool", "A custom tool", json!({"type": "object"}))
);

// Server tool (raw JSON)
let server = ToolDefinition::Server(json!({
    "type": "web_search_20250305",
    "name": "web_search",
    "max_uses": 5
}));

Variants§

§

Custom(CustomTool)

Custom client-side tool with name, description, and JSON schema

§

Server(Value)

Any server tool – uses raw JSON since server tool types vary

Trait Implementations§

Source§

impl Clone for ToolDefinition

Source§

fn clone(&self) -> ToolDefinition

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolDefinition

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<BashTool> for ToolDefinition

Source§

fn from(tool: BashTool) -> ToolDefinition

Converts to this type from the input type.
Source§

impl From<CodeExecutionTool> for ToolDefinition

Source§

fn from(tool: CodeExecutionTool) -> ToolDefinition

Converts to this type from the input type.
Source§

impl From<CustomTool> for ToolDefinition

Source§

fn from(tool: CustomTool) -> Self

Converts to this type from the input type.
Source§

impl From<MemoryTool> for ToolDefinition

Source§

fn from(tool: MemoryTool) -> ToolDefinition

Converts to this type from the input type.
Source§

impl From<TextEditorTool> for ToolDefinition

Source§

fn from(tool: TextEditorTool) -> ToolDefinition

Converts to this type from the input type.
Source§

impl From<ToolSearchBm25> for ToolDefinition

Source§

fn from(tool: ToolSearchBm25) -> ToolDefinition

Converts to this type from the input type.
Source§

impl From<ToolSearchRegex> for ToolDefinition

Source§

fn from(tool: ToolSearchRegex) -> ToolDefinition

Converts to this type from the input type.
Source§

impl From<WebFetchTool> for ToolDefinition

Source§

fn from(tool: WebFetchTool) -> ToolDefinition

Converts to this type from the input type.
Source§

impl From<WebSearchTool> for ToolDefinition

Source§

fn from(tool: WebSearchTool) -> ToolDefinition

Converts to this type from the input type.
Source§

impl Serialize for ToolDefinition

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more