Struct ToolSchema 

#[non_exhaustive]
pub struct ToolSchema {
    pub name: String,
    pub description: String,
    pub parameters: Value,
}

A tool advertised to the model: name, description, and JSON-Schema parameters.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Tool name (must match the registered crate::Tool).

description: String

Description the model uses to decide when to call it.

parameters: Value

JSON Schema for the tool’s input object.

Implementations

impl ToolSchema

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

Construct a schema directly (e.g. an embedder computing its own advertised set outside an crate::Agent, as the CLI’s inspect does for TR-8/T5’s before/after token measurement). #[non_exhaustive] blocks the struct-literal form outside this crate, so this is the supported way in.

Trait Implementations

impl Clone for ToolSchema

fn clone(&self) -> ToolSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolSchema

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

Formats the value using the given formatter.

impl PartialEq for ToolSchema

fn eq(&self, other: &ToolSchema) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ToolSchema

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 ToolSchema