Struct ToolDefinition 

pub struct ToolDefinition {
    pub manifest: ToolManifest,
    pub contract: ToolContract,
}

Static authoring helper for tools.

Composes the runtime ToolManifest and ToolContract projections. Both are #[serde(flatten)]ed so the serialized JSON shape stays flat (and wire/ persistence compatible); the two structs have disjoint field names.

Fields

manifest: ToolManifest

contract: ToolContract

Implementations

impl ToolDefinition

pub fn raw_with_id( id: impl Into<ToolId>, name: impl Into<String>, description: impl Into<String>, input_schema: Value, output_schema: Value, ) -> ToolDefinition

pub fn raw_named( name: impl Into<String>, description: impl Into<String>, input_schema: Value, output_schema: Value, ) -> ToolDefinition

pub fn typed_with_id<Args, Output>( id: impl Into<ToolId>, name: impl Into<String>, description: impl Into<String>, ) -> ToolDefinition

where Args: JsonSchema, Output: JsonSchema,

pub fn typed<Args, Output>( name: impl Into<String>, description: impl Into<String>, ) -> ToolDefinition

where Args: JsonSchema, Output: JsonSchema,

pub fn raw( id: impl Into<ToolId>, name: impl Into<String>, description: impl Into<String>, input_schema: Value, output_schema: Value, ) -> ToolDefinition

pub fn with_examples(self, examples: Vec<String>) -> ToolDefinition

pub fn with_availability( self, availability: ToolAvailabilityConfig, ) -> ToolDefinition

pub fn with_activation(self, activation: ToolActivation) -> ToolDefinition

pub fn with_agent_surface( self, agent_surface: ToolAgentSurface, ) -> ToolDefinition

pub fn with_argument_projection( self, argument_projection: ToolArgumentProjectionPolicy, ) -> ToolDefinition

pub fn with_scheduling(self, scheduling: ToolScheduling) -> ToolDefinition

pub fn with_retry_policy(self, retry_policy: ToolRetryPolicy) -> ToolDefinition

pub fn with_output_contract( self, output_contract: ToolOutputContract, ) -> ToolDefinition

pub fn with_input_schema_projection( self, profile: impl Into<String>, schema: Value, ) -> ToolDefinition

pub fn with_output_schema_projection( self, profile: impl Into<String>, schema: Value, ) -> ToolDefinition

pub fn with_output_from_input_schema( self, input_field: impl Into<String>, default_schema: Option<Value>, ) -> ToolDefinition

pub fn default_input_schema() -> Value

pub fn id(&self) -> &ToolId

Tool identity. Read very widely, so exposed as a thin accessor over the composed ToolManifest.

pub fn name(&self) -> &str

Tool name. Read very widely, so exposed as a thin accessor.

pub fn description(&self) -> &str

Tool description. Read very widely, so exposed as a thin accessor.

pub fn input_signature(&self) -> String

pub fn output_summary(&self) -> String

pub fn signature(&self) -> String

pub fn compact_contract(&self) -> CompactToolContract

pub fn compact_contract_with_example_limit( &self, example_limit: usize, ) -> CompactToolContract

pub fn effective_availability(&self) -> ToolAvailability

pub fn model_tool(&self) -> ModelTool

pub fn manifest(&self) -> ToolManifest

Project the manifest, computing the catalog-facing compact contract from the resolved ToolContract.

pub fn contract(&self) -> ToolContract

pub fn from_parts( manifest: ToolManifest, contract: ToolContract, ) -> ToolDefinition

Recompose a definition from its ToolManifest and ToolContract projections — the inverse of ToolDefinition::manifest/ToolDefinition::contract.

pub fn format_tool_docs(tools: &[ToolDefinition]) -> String

pub fn format_tool_docs_iter<'a>( tools: impl IntoIterator<Item = &'a ToolDefinition>, ) -> String

pub fn parameter_metadata(&self) -> Vec<Value>

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<'de> Deserialize<'de> for ToolDefinition

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToolDefinition, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.