Skip to main content

Tool

protocol_droid::domain::registry::primitive

Struct Tool

pub struct Tool {
    pub name: PrimitiveId,
    pub title: Option<String>,
    pub description: Option<String>,
    pub input_schema: JsonObject,
    pub output_schema: Option<JsonObject>,
    pub annotations: Option<ToolAnnotations>,
    pub icons: Option<Vec<ResourceIcon>>,
    pub extensions: Extensions,
}

Expand description

A tool a client can call.

name and inputSchema are required by every revision including 2026-07-28; everything else was added later and is None for a tool authored against 2024-11-05.

Fields§

§name: PrimitiveId

name. Required by every revision.

§title: Option<String>

title. 2026-07-28.

§description: Option<String>

description. Every revision.

§input_schema: JsonObject

inputSchema. Required by every revision, and a JSON Schema object.

Stored as the original text, validated once. See the module docs.

§output_schema: Option<JsonObject>

outputSchema. 2025-06-18.

§annotations: Option<ToolAnnotations>

annotations. Typed in 2025-03-26; untyped in nothing — the field itself first appears there.

§icons: Option<Vec<ResourceIcon>>

icons. 2026-07-28.

§extensions: Extensions

_meta and any field a later revision adds.

Implementations§

impl Tool

pub fn new( name: impl Into<PrimitiveId>, input_schema: &str, ) -> Result<Self, JsonObjectError>

A tool with a name and its input schema, and nothing else.

§Errors

Returns the JsonObject from parsing input_schema, which is the only fallible step: the schema is validated here, once, so nothing downstream has to.

pub fn described(self, description: impl Into<String>) -> Self

A human-readable description.

pub fn with_output_schema(self, schema: &str) -> Result<Self, JsonObjectError>

An output schema, which makes the feature ToolStructuredOutput (2025-06-18) a requirement of this tool.

§Errors

Propagates the parse failure for schema.

Trait Implementations§

impl Clone for Tool

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

impl Debug for Tool

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

Formats the value using the given formatter. Read more

impl From<Tool> for Primitive

fn from(tool: Tool) -> Self

Converts to this type from the input type.

impl PartialEq for Tool

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for Tool

Auto Trait Implementations§

impl Freeze for Tool

impl RefUnwindSafe for Tool

impl Send for Tool

impl Sync for Tool

impl Unpin for Tool

impl UnsafeUnpin for Tool

impl UnwindSafe for Tool

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

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

fn into(self) -> U

Calls U::from(self).

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

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

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

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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