Struct Tool 

pub struct Tool {
    pub name: String,
    pub description: String,
    pub parameters: Option<Value>,
    pub execute: ToolExecutionLocation,
}

AG-UI tool definition.

Fields

name: String

Tool name.

description: String

Tool description.

parameters: Option<Value>

JSON Schema for tool parameters.

execute: ToolExecutionLocation

Where the tool executes (frontend or backend).

Implementations

impl Tool

pub fn backend(name: impl Into<String>, description: impl Into<String>) -> Self

Create a new backend tool definition.

pub fn frontend(name: impl Into<String>, description: impl Into<String>) -> Self

Create a new frontend tool definition.

pub fn with_parameters(self, parameters: Value) -> Self

Set the JSON Schema parameters.

pub fn is_frontend(&self) -> bool

Check if this is a frontend tool.

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