Skip to main content

Tool

Struct Tool 

Source
pub struct Tool {
    pub name: String,
    pub description: String,
    pub input_schema: Value,
    pub source: ToolSource,
    pub execute: ExecuteFn,
    pub hints: Option<ToolHints>,
    pub concurrency_safe: Option<ConcurrencySafeFn>,
    pub output_schema: Option<Value>,
    pub annotations: Option<ToolAnnotations>,
}
Expand description

A named, described, schema’d callable (SPEC §1).

Fields§

§name: String§description: String§input_schema: Value

JSON-Schema object for the arguments.

§source: ToolSource§execute: ExecuteFn§hints: Option<ToolHints>

Advisory hints (read-only / destructive / open-world); None = unknown.

§concurrency_safe: Option<ConcurrencySafeFn>

Decides per call whether this tool may run alongside other safe calls of the same model response (SPEC §8 “Tool scheduling”). None ⇒ safe only when hints.read_only. See is_concurrency_safe.

§output_schema: Option<Value>

JSON Schema of ToolResult::structured (§1). MCP serve advertises it as outputSchema; None ⇒ omitted.

§annotations: Option<ToolAnnotations>

MCP annotations, passed through verbatim by the MCP handler (else derived from hints, else omitted). Never sent to the model.

Implementations§

Source§

impl Tool

Source

pub fn with_output_schema(self, schema: Value) -> Self

This tool with an output schema (§1).

Source

pub fn with_annotations(self, annotations: ToolAnnotations) -> Self

This tool with MCP annotations (§7C.1).

Source

pub fn with_concurrency_safe( self, f: impl Fn(&Value) -> bool + Send + Sync + 'static, ) -> Self

This tool with a per-call concurrency-safety predicate.

Source§

impl Tool

Source

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

Run the tool. A missing/null args value is passed as {}.

Trait Implementations§

Source§

impl Clone for Tool

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Tool

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Tool

§

impl !UnwindSafe for Tool

§

impl Freeze for Tool

§

impl Send for Tool

§

impl Sync for Tool

§

impl Unpin for Tool

§

impl UnsafeUnpin for Tool

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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