Struct Tool

Source
pub struct Tool {
    pub info: ToolInfo,
    pub handler: Box<dyn ToolHandler>,
    pub enabled: bool,
    pub validator: Option<ParameterValidator>,
    pub enhanced_metadata: EnhancedToolMetadata,
}
Expand description

A registered tool with its handler, validation, and enhanced metadata

Fields§

§info: ToolInfo

Information about the tool

§handler: Box<dyn ToolHandler>

Handler that implements the tool’s functionality

§enabled: bool

Whether the tool is currently enabled

§validator: Option<ParameterValidator>

Parameter validator for input validation

§enhanced_metadata: EnhancedToolMetadata

Enhanced metadata for tool behavior, categorization, and performance

Implementations§

Source§

impl Tool

Source

pub fn new<H>( name: String, description: Option<String>, input_schema: Value, handler: H, ) -> Self
where H: ToolHandler + 'static,

Create a new tool with the given information and handler

§Arguments
  • name - Name of the tool
  • description - Optional description of the tool
  • input_schema - JSON schema describing the input parameters
  • handler - Implementation of the tool’s functionality
Source

pub fn with_validation<H>( name: String, description: Option<String>, input_schema: Value, handler: H, validation_config: ValidationConfig, ) -> Self
where H: ToolHandler + 'static,

Create a new tool with custom validation configuration

Source

pub fn enable(&mut self)

Enable the tool

Source

pub fn disable(&mut self)

Disable the tool

Source

pub fn is_enabled(&self) -> bool

Check if the tool is enabled

Source

pub async fn call( &self, arguments: HashMap<String, Value>, ) -> McpResult<ToolResult>

Execute the tool if it’s enabled with parameter validation and performance tracking

§Arguments
  • arguments - Tool arguments as key-value pairs
§Returns

Result containing the tool execution result or an error

Source

pub async fn call_unchecked( &self, arguments: HashMap<String, Value>, ) -> McpResult<ToolResult>

Execute the tool without validation or performance tracking (for advanced use cases)

Source

pub fn validate_parameters( &self, arguments: &mut HashMap<String, Value>, ) -> McpResult<()>

Validate parameters without executing the tool

Source

pub fn set_behavior_hints(&mut self, hints: ToolBehaviorHints)

Set behavior hints for the tool

Source

pub fn behavior_hints(&self) -> &ToolBehaviorHints

Get behavior hints for the tool

Source

pub fn set_category(&mut self, category: ToolCategory)

Set category for the tool

Source

pub fn category(&self) -> Option<&ToolCategory>

Get category for the tool

Source

pub fn set_version(&mut self, version: String)

Set version for the tool

Source

pub fn version(&self) -> Option<&String>

Get version of the tool

Source

pub fn set_author(&mut self, author: String)

Set author for the tool

Source

pub fn author(&self) -> Option<&String>

Get author of the tool

Source

pub fn deprecate(&mut self, deprecation: ToolDeprecation)

Mark tool as deprecated

Source

pub fn is_deprecated(&self) -> bool

Check if tool is deprecated

Source

pub fn deprecation_warning(&self) -> Option<String>

Get deprecation warning if tool is deprecated

Source

pub fn performance_metrics(&self) -> ToolPerformanceMetrics

Get performance metrics for the tool

Source

pub fn add_custom_metadata(&mut self, key: String, value: Value)

Add custom metadata field

Source

pub fn get_custom_metadata(&self, key: &str) -> Option<&Value>

Get custom metadata field

Source

pub fn matches_category_filter(&self, filter: &CategoryFilter) -> bool

Check if tool matches a category filter

Source

pub fn is_cacheable(&self) -> bool

Check if tool is suitable for caching based on behavior hints

Source

pub fn is_destructive(&self) -> bool

Check if tool is destructive

Source

pub fn is_read_only(&self) -> bool

Check if tool is read-only

Source

pub fn is_idempotent(&self) -> bool

Check if tool is idempotent

Source

pub fn requires_auth(&self) -> bool

Check if tool requires authentication

Trait Implementations§

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 Freeze for Tool

§

impl !RefUnwindSafe for Tool

§

impl Send for Tool

§

impl Sync for Tool

§

impl Unpin for Tool

§

impl !UnwindSafe 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> 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: 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

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