Struct ToolDefinition

pub struct ToolDefinition {
    pub description: String,
    pub parameters: Vec<ParameterDefinition>,
    pub env_vars: Vec<EnvVarDefinition>,
    pub required_tools: Vec<String>,
    pub metadata: HashMap<String, Value>,
}

The definition of a tool, parsed from comments in its source code.

This structure captures everything needed to understand and use a tool, including its purpose, parameters, and dependencies.

Fields

description: String

A description of the tool’s purpose and functionality.

parameters: Vec<ParameterDefinition>

The parameters that the tool accepts.

env_vars: Vec<EnvVarDefinition>

Environment variables that are required for the tool’s execution.

required_tools: Vec<String>

A list of external command-line tools that this tool depends on.

metadata: HashMap<String, Value>

A map for any additional, unstructured metadata about the tool.

Implementations

impl ToolDefinition

pub fn to_function_declaration(&self, name: &str) -> Result<FunctionDeclaration>

Converts a ToolDefinition into a FunctionDeclaration for use with an LLM.

This is a crucial step for function calling, as it transforms the internal tool representation into a format that the AI model can understand.

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

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 JsonSchema for ToolDefinition

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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.