Skip to main content

ToolMiddleware

Struct ToolMiddleware 

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

Intercepts execute() on a wrapped AgentTool.

All descriptor methods (name, label, description, parameters_schema, metadata, requires_approval, auth_config) delegate to the inner tool.

Implementations§

Source§

impl ToolMiddleware

Source

pub fn new<F>(inner: Arc<dyn AgentTool>, f: F) -> Self

Create a new middleware wrapping inner.

The closure receives (inner_tool, tool_call_id, params, cancel, on_update, state, credential) and can call through to the inner tool’s execute() at any point.

Source

pub fn with_timeout(inner: Arc<dyn AgentTool>, timeout: Duration) -> Self

Create a middleware that enforces a timeout on tool execution.

If the inner tool does not complete within timeout, an error result is returned.

Source

pub fn with_logging<F>(inner: Arc<dyn AgentTool>, callback: F) -> Self
where F: Fn(&str, &str, bool) + Send + Sync + 'static,

Create a middleware that calls a logging callback before and after tool execution.

The callback receives (tool_name, tool_call_id, is_start) where is_start is true before execution and false after.

Trait Implementations§

Source§

impl AgentTool for ToolMiddleware

Source§

fn name(&self) -> &str

Unique routing key used to dispatch tool calls.
Source§

fn label(&self) -> &str

Human-readable display name for logging and UI.
Source§

fn description(&self) -> &str

Natural-language description included in the LLM prompt.
Source§

fn parameters_schema(&self) -> &Value

JSON Schema describing the tool’s input shape, used for validation.
Source§

fn metadata(&self) -> Option<ToolMetadata>

Optional organizational metadata (namespace, version). Read more
Source§

fn requires_approval(&self) -> bool

Whether this tool requires user approval before execution. Default is false — tools execute immediately.
Source§

fn approval_context(&self, params: &Value) -> Option<Value>

Optional rich context for the approval UI. Read more
Source§

fn auth_config(&self) -> Option<AuthConfig>

Optional authentication configuration for this tool. Read more
Source§

fn execute( &self, tool_call_id: &str, params: Value, cancellation_token: CancellationToken, on_update: Option<Box<dyn Fn(AgentToolResult) + Send + Sync>>, state: Arc<RwLock<SessionState>>, credential: Option<ResolvedCredential>, ) -> ToolFuture<'_>

Execute the tool with validated parameters. Read more
Source§

impl Debug for ToolMiddleware

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> IntoTool for T
where T: AgentTool + 'static,

Source§

fn into_tool(self) -> Arc<dyn AgentTool>

Wrap this tool in an Arc<dyn AgentTool>.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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, 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