Struct ToolDefinition 

#[non_exhaustive]
pub struct ToolDefinition {
    pub name: String,
    pub description: String,
    pub input_schema: Value,
    pub tags: Vec<ToolTag>,
    pub cache_control: Option<CacheControl>,
}

Tool description sent to the provider so the model can decide when and how to call it.

ToolDefinition is the wire-level shape; tool implementations live behind the ailoop-tools Tool / ToolDyn traits and only produce a ToolDefinition when they are mounted on a ChatRequest.

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

Tool name; must match the name the model emits on crate::AssistantBlock::ToolCall.

description: String

Human-readable description used by the model to decide when to invoke the tool.

input_schema: Value

JSON Schema (2020-12) for the tool’s input arguments.

tags: Vec<ToolTag>

Tags consumed by capability gating and approval middleware.

cache_control: Option<CacheControl>

Cache breakpoint for this tool entry on providers that support per-tool prompt caching (Anthropic). Adapters without per-tool caching ignore the field.

Implementations

impl ToolDefinition

pub fn new( name: &str, description: &str, input_schema: Value, tags: Vec<ToolTag>, ) -> ToolDefinition

Build a definition with the given identity, schema, and tags and no cache breakpoint.

pub fn with_cache_control(self, cache_control: CacheControl) -> ToolDefinition

Builder-style helper: attach a cache breakpoint to this tool entry.

Trait Implementations

impl Clone for ToolDefinition

fn clone(&self) -> ToolDefinition

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<(), Error>

Formats the value using the given formatter.

impl Serialize for ToolDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.