Struct ToolMetadata 

#[non_exhaustive]
pub struct ToolMetadata {
    pub concurrency: ConcurrencyMode,
    pub destructiveness: Destructiveness,
    pub interrupt: InterruptBehavior,
    pub timeout: Option<Duration>,
    pub capabilities: Vec<CapabilityFlag>,
    pub max_concurrency: Option<usize>,
}

Metadata used by dispatch and capability filters.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

concurrency: ConcurrencyMode

Concurrency class.

destructiveness: Destructiveness

Destructiveness.

interrupt: InterruptBehavior

Interrupt behavior.

timeout: Option<Duration>

Optional execution timeout.

capabilities: Vec<CapabilityFlag>

Capability flags required/advertised.

max_concurrency: Option<usize>

Optional per-tool concurrency cap (alongside ConcurrencyMode).

Implementations

impl ToolMetadata

pub fn read_only() -> Self

Read-only tool defaults.

pub fn exclusive_write() -> Self

Exclusive mutating tool defaults.

pub fn spawn() -> Self

Nested-agent spawn tool defaults (concurrent, non-destructive).

pub fn shell_execute(timeout: Duration) -> Self

Exclusive shell / process execution defaults.

pub const fn with_max_concurrency(self, n: Option<usize>) -> Self

Set per-tool concurrency cap.

pub fn allowed_in_read_only(&self) -> bool

True when the tool is admissible under a read-only capability mode.

Trait Implementations

impl Clone for ToolMetadata

fn clone(&self) -> ToolMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolMetadata

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

Formats the value using the given formatter.

impl Default for ToolMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.