Struct Tool 

pub struct Tool {
    pub name: String,
    pub description: String,
    pub parameters: Value,
    pub metadata: Option<JsonObject>,
}

A tool the agent may call.

parameters is a JSON Schema object describing the call arguments; it is carried verbatim and never interpreted by this crate.

Fields

name: String

The name the model uses to call this tool.

description: String

What the tool does — the model reads this to decide when to call it.

parameters: Value

JSON Schema for the call arguments.

metadata: Option<JsonObject>

Arbitrary integration-specific metadata (for example an A2UI schema).

Implementations

impl Tool

pub fn new( name: impl Into<String>, description: impl Into<String>, parameters: impl Into<Value>, ) -> Self

Builds a tool definition from a name, description and parameter schema.

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

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for Tool

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

Formats the value using the given formatter.

impl Default for Tool

fn default() -> Tool

Returns the “default value” for a type.

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

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

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

impl ToSchema for Tool

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.