Struct UserToolDefinition 

pub struct UserToolDefinition {
    pub name: String,
    pub description: String,
    pub parameters: Option<Value>,
    pub strict: Option<bool>,
}

A user-defined tool that agents can call during deliberation. The schema follows the OpenAI function calling format.

Fields

name: String

Tool name as provided by the user (e.g., “dm_user”, “read_user_file”). Will be presented to the LLM with a “user_” prefix.

description: String

Human-readable description of what this tool does.

parameters: Option<Value>

JSON Schema for tool parameters (OpenAI function calling format). Follows OpenAI’s parameters field: { "type": "object", "properties": {...}, "required": [...] }

strict: Option<bool>

Whether the LLM must strictly match the schema. Mirrors OpenAI’s strict field.

Trait Implementations

impl Clone for UserToolDefinition

fn clone(&self) -> UserToolDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for UserToolDefinition

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for UserToolDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserToolDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for UserToolDefinition

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for UserToolDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for UserToolDefinition

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

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.