Struct Tool

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

Definition for a tool the client can call.

JSON schema
{
 "description": "Definition for a tool the client can call.",
 "type": "object",
 "required": [
   "inputSchema",
   "name"
 ],
 "properties": {
   "_meta": {
     "description": "See [specification/2025-06-18/basic/index#general-fields] for notes on _meta usage.",
     "type": "object",
     "additionalProperties": {}
   },
   "annotations": {
     "description": "Optional additional tool information.\n\nDisplay name precedence order is: title, annotations.title, then name.",
     "$ref": "#/definitions/ToolAnnotations"
   },
   "description": {
     "description": "A human-readable description of the tool.\n\nThis can be used by clients to improve the LLM's understanding of available tools. It can be thought of like a \"hint\" to the model.",
     "type": "string"
   },
   "inputSchema": {
     "description": "A JSON Schema object defining the expected parameters for the tool.",
     "type": "object",
     "required": [
       "type"
     ],
     "properties": {
       "properties": {
         "type": "object",
         "additionalProperties": {
           "type": "object",
           "additionalProperties": true
         }
       },
       "required": {
         "type": "array",
         "items": {
           "type": "string"
         }
       },
       "type": {
         "type": "string",
         "const": "object"
       }
     }
   },
   "name": {
     "description": "Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).",
     "type": "string"
   },
   "outputSchema": {
     "description": "An optional JSON Schema object defining the structure of the tool's output returned in\nthe structuredContent field of a CallToolResult.",
     "type": "object",
     "required": [
       "type"
     ],
     "properties": {
       "properties": {
         "type": "object",
         "additionalProperties": {
           "type": "object",
           "additionalProperties": true
         }
       },
       "required": {
         "type": "array",
         "items": {
           "type": "string"
         }
       },
       "type": {
         "type": "string",
         "const": "object"
       }
     }
   },
   "title": {
     "description": "Intended for UI and end-user contexts — optimized to be human-readable and easily understood,\neven by those unfamiliar with domain-specific terminology.\n\nIf not provided, the name should be used for display (except for Tool,\nwhere annotations.title should be given precedence over using name,\nif present).",
     "type": "string"
   }
 }
}

Fields§

§annotations: Option<ToolAnnotations>

Optional additional tool information. Display name precedence order is: title, annotations.title, then name.

§description: Option<String>

A human-readable description of the tool. This can be used by clients to improve the LLM’s understanding of available tools. It can be thought of like a “hint” to the model.

§input_schema: ToolInputSchema§meta: Option<Map<String, Value>>

See [specification/2025-06-18/basic/index#general-fields] for notes on _meta usage.

§name: String

Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn’t present).

§output_schema: Option<ToolOutputSchema>§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. If not provided, the name should be used for display (except for Tool, where annotations.title should be given precedence over using name, if present).

Trait Implementations§

Source§

impl Clone for Tool

Source§

fn clone(&self) -> Tool

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

const 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

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

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

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 Serialize for Tool

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§

§

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, 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>,