Skip to main content

Toolset

Struct Toolset 

Source
pub struct Toolset { /* private fields */ }
Expand description

Opaque cloneable Toolset over Local, MCP, or downstream behavior. Clones share admission and cleanup. Dropping a clone alone does not initiate asynchronous cleanup; explicitly await ToolsetBackend::shutdown.

§Examples


use tools_kit::{Toolset, ToolsetBackend};
let tools = Toolset::local(Vec::new())?;
assert!(tools.list_tools().await?.is_empty());
tools.shutdown().await?;

Implementations§

Source§

impl Toolset

Source

pub fn local(registrations: Vec<ToolRegistration>) -> Result<Self, ToolError>

Builds an in-process Toolset from complete registrations.

§Errors

Returns ToolError::DuplicateName for duplicate names; an empty inventory is valid.

§Examples

use tools_kit::{Toolset, ToolsetBackend};
let tools = Toolset::local(Vec::new())?;
assert!(tools.list_tools().await?.is_empty());
tools.shutdown().await?;
Source

pub async fn mcp(config: McpClientConfig) -> Result<Self, ToolError>

Connects one MCP client Toolset and discovers its inventory. This example requires a running MCP service at the configured endpoint.

§Errors

Returns ToolError for invalid connection settings, process startup, transport or initialization failure, malformed inventory, or an elapsed request deadline.

§Examples

use tools_kit::mcp::{McpClientConfig, McpConnectionConfig};
let connection = McpConnectionConfig::StreamableHttp { endpoint: "http://127.0.0.1:8000/mcp".parse().unwrap(), headers: Default::default() };
let config = McpClientConfig::new(connection);
use tools_kit::{Toolset, ToolsetBackend};
let tools = Toolset::mcp(config).await?;
let inventory = tools.list_tools().await;
let cleanup = tools.shutdown().await;
let _ = inventory?;
cleanup?;
Source

pub fn from_backend<B: ToolsetBackend>(backend: B) -> Self

Wraps a downstream Toolset implementation. The associated handler is normalized privately. Concrete callers may instead retain the backend directly; there is no public child normalization constructor.

§Examples

use std::sync::atomic::{AtomicBool, Ordering};
use tools_kit::{ToolError, Toolset, ToolsetBackend, ToolHandlerBackend};
use tools_kit::declaration::{ToolInfo, ToolName};
use tools_kit::execution::{ToolHandlerInput, ToolHandlerOutput};
struct EmptyInventory { closed: AtomicBool }
enum NoHandler {}
impl ToolHandlerBackend for NoHandler {
    async fn step(&mut self, _: ToolHandlerInput) -> Result<ToolHandlerOutput, ToolError> {
        match *self {}
    }
}
impl ToolsetBackend for EmptyInventory {
    type Handler = NoHandler;
    async fn list_tools(&self) -> Result<Vec<ToolInfo>, ToolError> {
        if self.closed.load(Ordering::Acquire) {
            return Err(ToolError::Closed { operation: "list_tools".into() });
        }
        Ok(Vec::new())
    }
    async fn tool_handler(&self, name: ToolName) -> Result<NoHandler, ToolError> {
        if self.closed.load(Ordering::Acquire) {
            return Err(ToolError::Closed { operation: "tool_handler".into() });
        }
        Err(ToolError::UnknownTool { name })
    }
    async fn shutdown(&self) -> Result<(), ToolError> {
        self.closed.store(true, Ordering::Release);
        Ok(()) // This empty implementation owns no asynchronous resources.
    }
}
let concrete = EmptyInventory { closed: AtomicBool::new(false) };
assert!(concrete.list_tools().await?.is_empty());
let normalized = Toolset::from_backend(concrete);
normalized.shutdown().await?;
assert!(normalized.list_tools().await.is_err());

Trait Implementations§

Source§

impl Clone for Toolset

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 Toolset

Source§

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

Formats the value using the given formatter. Read more
Source§

impl ToolsetBackend for Toolset

Source§

type Handler = ToolHandler

Unique resumable handler produced by this tool source.
Source§

async fn list_tools(&self) -> Result<Vec<ToolInfo>, ToolError>

Lists the complete executable inventory. Read more
Source§

async fn tool_handler(&self, name: ToolName) -> Result<Self::Handler, ToolError>

Creates a unique handler for one selected tool name. Read more
Source§

async fn shutdown(&self) -> Result<(), ToolError>

Seals admission and performs shared exactly-once cleanup. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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

Source§

fn from_ref(input: &T) -> T

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

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

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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