Skip to main content

ToolSpec

Struct ToolSpec 

Source
pub struct ToolSpec {
    pub name: String,
    pub description: String,
    pub handler: AsyncToolHandler,
    pub required_fields: Vec<String>,
    pub circuit_breaker: Option<Arc<CircuitBreaker>>,
}
Expand description

Describes and implements a single callable tool.

Fields§

§name: String

Short identifier used in action strings (e.g. “search”).

§description: String

Human-readable description passed to the model as part of the system prompt.

§handler: AsyncToolHandler

Async handler: receives JSON arguments, returns a future resolving to a JSON result.

§required_fields: Vec<String>

Field names that must be present in the JSON args object. Empty means no validation is performed.

§circuit_breaker: Option<Arc<CircuitBreaker>>

Optional per-tool circuit breaker.

Implementations§

Source§

impl ToolSpec

Source

pub fn new( name: impl Into<String>, description: impl Into<String>, handler: impl Fn(Value) -> Value + Send + Sync + 'static, ) -> Self

Construct a new ToolSpec from a synchronous handler closure. The closure is wrapped in an async move block automatically.

Source

pub fn new_async( name: impl Into<String>, description: impl Into<String>, handler: impl Fn(Value) -> AsyncToolFuture + Send + Sync + 'static, ) -> Self

Construct a new ToolSpec from an async handler closure.

Source

pub fn with_required_fields(self, fields: Vec<String>) -> Self

Set the required fields that must be present in the JSON args object.

Source

pub fn with_circuit_breaker(self, cb: Arc<CircuitBreaker>) -> Self

Attach a circuit breaker to this tool spec.

Source

pub async fn call(&self, args: Value) -> Value

Invoke the tool with the given JSON arguments.

Trait Implementations§

Source§

impl Debug for ToolSpec

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more