Struct ToolDefinition 

#[non_exhaustive]
pub struct ToolDefinition {
    pub name: String,
    pub description: String,
    pub parameter_schema: Value,
    pub effect: ToolEffect,
    pub output_sanitization: OutputSanitization,
    /* private fields */
}

Describes a custom tool that can be registered with an agent.

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.

name: String

Unique tool name (e.g. "flash_device").

description: String

Human-readable description shown to the model.

parameter_schema: Value

JSON Schema describing the tool’s parameters.

effect: ToolEffect

Execution effect classification of the tool.

output_sanitization: OutputSanitization

Automatic prompt-injection sanitization policy applied to the tool’s output.

Implementations

impl ToolDefinition

pub fn new( name: impl Into<String>, description: impl Into<String>, parameter_schema: Value, ) -> Self

Construct a ToolDefinition with default ToolEffect::Mutating and the secure default OutputSanitization::SanitizeTokens.

pub fn from_schema<T: JsonSchema>( name: impl Into<String>, description: impl Into<String>, ) -> Result<Self, Error>

Construct a ToolDefinition directly from a parameter struct T implementing schemars::JsonSchema.

Errors

Returns the serde_json::Error if the generated schema cannot be converted to a JSON value.

pub fn with_effect( name: impl Into<String>, description: impl Into<String>, parameter_schema: Value, effect: ToolEffect, ) -> Self

Construct a ToolDefinition with an explicit ToolEffect.

pub const fn with_output_sanitization( self, sanitization: OutputSanitization, ) -> Self

Attach an OutputSanitization policy to this ToolDefinition. Chainable.

pub fn set_parameter_schema(&mut self, parameter_schema: Value)

Update parameter_schema and invalidate any cached JSON serialization.

pub fn parameter_schema_mut(&mut self) -> &mut Value

Borrow parameter_schema mutably and invalidate any cached JSON serialization.

pub fn parameter_schema_json(&self) -> &str

Return the pre-serialized JSON schema string (&str), lazily derived from parameter_schema.

pub fn parameter_schema_json_arc(&self) -> &Arc<str>

Return the pre-serialized JSON schema string (&Arc<str>), lazily derived from parameter_schema.

pub const fn is_idempotent(&self) -> bool

Whether repeated invocations with identical arguments are side-effect free / idempotent.

Preserved for backward compatibility.

Trait Implementations

impl Clone for ToolDefinition

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolDefinition

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ToolDefinition

impl PartialEq for ToolDefinition

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ToolDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.