Struct ToolSpec 

#[non_exhaustive]
pub struct ToolSpec {
    pub name: String,
    pub description: String,
    pub input_schema: Option<ToolInputSchema>,
}

Specification for a tool that acts can invoke, including its name, description, and input schema.

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

The unique name of the tool that acts will use to invoke it.

description: String

A description of what the tool does and how it should be used.

input_schema: Option<ToolInputSchema>

The JSON schema that defines the expected input format for the tool.

Implementations

impl ToolSpec

pub fn name(&self) -> &str

The unique name of the tool that acts will use to invoke it.

pub fn description(&self) -> &str

A description of what the tool does and how it should be used.

pub fn input_schema(&self) -> Option<&ToolInputSchema>

The JSON schema that defines the expected input format for the tool.

impl ToolSpec

pub fn builder() -> ToolSpecBuilder

Creates a new builder-style object to manufacture ToolSpec.

Trait Implementations

impl Clone for ToolSpec

fn clone(&self) -> ToolSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolSpec

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

Formats the value using the given formatter.

impl PartialEq for ToolSpec

fn eq(&self, other: &ToolSpec) -> 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 StructuralPartialEq for ToolSpec