Skip to main content

ToolDefinition

Struct ToolDefinition 

Source
pub struct ToolDefinition {
    pub id: String,
    pub name: String,
    pub category: ToolCategory,
    pub risk_score: f64,
    pub requires_approval: bool,
    pub rate_limit: Option<u32>,
    pub required_permissions: Vec<String>,
    pub description: String,
}
Expand description

Definition of a tool with security metadata.

Each tool registered in the ToolRegistry carries metadata that the security engine uses to assess risk, enforce rate limits, and decide whether user approval is required.

Fields§

§id: String

Unique tool identifier (e.g., "web_search", "file_read").

§name: String

Human-readable name.

§category: ToolCategory

Security category.

§risk_score: f64

Risk score 0.0–1.0 (0 = safe, 1 = dangerous).

§requires_approval: bool

Whether this tool requires explicit user approval before execution.

§rate_limit: Option<u32>

Maximum calls per minute (None = unlimited).

§required_permissions: Vec<String>

List of permission strings required to use this tool.

§description: String

Description of what this tool does.

Implementations§

Source§

impl ToolDefinition

Source

pub fn new(id: &str, name: &str, category: ToolCategory) -> Self

Create a new tool definition with sensible defaults.

The risk score defaults to 0.5, approval is not required, and no per-tool rate limit is set.

Source

pub fn with_risk_score(self, score: f64) -> Self

Set the risk score (clamped to 0.0–1.0).

Source

pub fn with_requires_approval(self, requires: bool) -> Self

Set whether this tool requires user approval.

Source

pub fn with_rate_limit(self, limit: u32) -> Self

Set a per-tool rate limit (calls per minute).

Source

pub fn with_permission(self, permission: String) -> Self

Add a required permission string.

Source

pub fn with_description(self, description: String) -> Self

Set the tool description.

Trait Implementations§

Source§

impl Clone for ToolDefinition

Source§

fn clone(&self) -> ToolDefinition

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolDefinition

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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = 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