Struct ToolInfo 

pub struct ToolInfo {
    pub name: ToolName,
    pub title: Option<String>,
    pub description: Option<String>,
    pub input_schema: JsonSchema,
    pub output_schema: Option<JsonSchema>,
    pub annotations: ToolAnnotations,
    pub icons: Vec<ToolIcon>,
    pub interactions: ToolInteractionCapabilities,
    pub metadata: BTreeMap<String, Value>,
}

Complete source-neutral declaration for one executable tool. A declared output schema requires structured content on every successful result. Missing content fails; explicit JSON null is validated against the schema. Model-visible error results (is_error = true) are exempt from output-schema validation.

Examples

use tools_kit::{declaration::{ToolInfo, ToolName}, schema::JsonSchema};
let info = ToolInfo::new(ToolName::new("ping")?, JsonSchema::strict(serde_json::json!({"type":"object"})));
assert!(info.output_schema.is_none());

Fields

name: ToolName

Stable caller-facing name.

title: Option<String>

Optional display label.

description: Option<String>

Model-visible behavior description.

input_schema: JsonSchema

JSON Schema for invocation arguments.

output_schema: Option<JsonSchema>

Optional JSON Schema for structured output.

annotations: ToolAnnotations

Portable behavior hints.

icons: Vec<ToolIcon>

Optional visual metadata.

interactions: ToolInteractionCapabilities

Supported source-neutral caller interactions.

metadata: BTreeMap<String, Value>

Uninterpreted source-neutral metadata.

Implementations

impl ToolInfo

pub fn new(name: ToolName, input_schema: JsonSchema) -> Self

Creates a complete declaration with no optional metadata.

Examples

use tools_kit::{declaration::{ToolInfo, ToolName}, schema::JsonSchema};
let info = ToolInfo::new(ToolName::new("ping")?, JsonSchema::strict(serde_json::json!({"type":"object"})));
assert!(info.output_schema.is_none());

Trait Implementations

impl Clone for ToolInfo

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 ToolInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolInfo

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolInfo