Tool

Struct Tool 

Source
pub struct Tool {
    pub name: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub input_schema: ToolSchema,
    pub output_schema: Option<ToolSchema>,
    pub annotations: Option<ToolAnnotations>,
    pub meta: Option<HashMap<String, Value>>,
}
Expand description

Tool definition

Fields§

§name: String

The tool’s name - used as identifier when calling

§title: Option<String>

Intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology.

§description: Option<String>

Optional human-readable description

§input_schema: ToolSchema

JSON Schema for input parameters

§output_schema: Option<ToolSchema>

Optional JSON Schema for output results

§annotations: Option<ToolAnnotations>

Optional annotations for client hints

§meta: Option<HashMap<String, Value>>

Implementations§

Source§

impl Tool

Source

pub fn new(name: impl Into<String>, input_schema: ToolSchema) -> Tool

Source

pub fn with_title(self, title: impl Into<String>) -> Tool

Source

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

Source

pub fn with_output_schema(self, output_schema: ToolSchema) -> Tool

Source

pub fn with_annotations(self, annotations: ToolAnnotations) -> Tool

Source

pub fn with_meta(self, meta: HashMap<String, Value>) -> Tool

Trait Implementations§

Source§

impl Clone for Tool

Source§

fn clone(&self) -> Tool

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Tool

Source§

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

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

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

Source§

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

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

impl HasAnnotations for Tool

Source§

impl HasBaseMetadata for Tool

Source§

fn name(&self) -> &str

Programmatic identifier (fallback display name)
Source§

fn title(&self) -> Option<&str>

Human-readable display name (UI contexts)
Source§

impl HasDescription for Tool

Source§

impl HasInputSchema for Tool

Source§

impl HasOutputSchema for Tool

Source§

impl HasToolMeta for Tool

Source§

impl Serialize for Tool

Source§

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. Read more

Auto Trait Implementations§

§

impl Freeze for Tool

§

impl RefUnwindSafe for Tool

§

impl Send for Tool

§

impl Sync for Tool

§

impl Unpin for Tool

§

impl UnwindSafe for Tool

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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> ToolDefinition for T

Source§

fn display_name(&self) -> &str

Display name precedence: title > annotations.title > name (matches TypeScript spec)
Source§

fn to_tool(&self) -> Tool

Convert to concrete Tool struct for protocol serialization
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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,