Struct Tool

pub struct Tool {
    pub annotations: Option<ToolAnnotations>,
    pub description: Option<String>,
    pub input_schema: ToolInputSchema,
    pub name: String,
}

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": {
   "annotations": {
     "description": "Optional additional tool information.",
     "$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": "The name of the tool.",
     "type": "string"
   }
 }
}

Fields

annotations: Option<ToolAnnotations>

Optional additional tool information.

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

name: String

The name of the tool.

Implementations

impl Tool

pub fn new(name: &str, input_schema: ToolInputSchema) -> Self

pub fn with_description(self, description: &str) -> Self

pub fn with_annotations(self, annotations: impl Into<ToolAnnotations>) -> Self

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a copy 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 From<&Tool> for Tool

fn from(value: &Tool) -> Self

Converts to this type from the input type.

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