Struct ToolDefinition 

pub struct ToolDefinition {
    pub tool_type: String,
    pub function: Option<FunctionDefinition>,
    pub allowed_callers: Option<Vec<String>>,
    pub input_examples: Option<Vec<Value>>,
    pub web_search: Option<Value>,
    pub hosted_tool_config: Option<Value>,
    pub shell: Option<ShellToolDefinition>,
    pub grammar: Option<GrammarDefinition>,
    pub strict: Option<bool>,
    pub defer_loading: Option<bool>,
}

Universal tool definition that matches OpenAI/Anthropic/Gemini specifications Based on official API documentation from Context7

Fields

tool_type: String

The type of tool: “function”, “apply_patch” (GPT-5.1), “shell” (GPT-5.1), or “custom” (GPT-5 freeform) Also supports provider-native and hosted tool types like:

• “tool_search” (OpenAI hosted tool search)
• “file_search” and “mcp” (OpenAI Responses hosted tools)
• Anthropic tool search revisions:
• “tool_search_tool_regex_20251119”, “tool_search_tool_bm25_20251119”
• “web_search_20260209” (and other web_search_* revisions)
• “code_execution_20250825” (and other code_execution_* revisions)
• “memory_20250818” (and other memory_* revisions)

function: Option<FunctionDefinition>

Function definition containing name, description, and parameters Used for “function”, “apply_patch”, and “custom” types

allowed_callers: Option<Vec<String>>

Restricts which Anthropic callers can invoke this tool programmatically.

input_examples: Option<Vec<Value>>

Anthropic tool use examples used to teach complex tool behavior.

web_search: Option<Value>

Provider-native web search configuration payload (e.g. Z.AI web_search tool).

hosted_tool_config: Option<Value>

Provider-hosted Responses tool configuration for tool types like file_search and mcp.

shell: Option<ShellToolDefinition>

Shell tool configuration (GPT-5.1 specific) Describes shell command capabilities and constraints

grammar: Option<GrammarDefinition>

Grammar definition for context-free grammar constraints (GPT-5 specific)

strict: Option<bool>

When true and using Anthropic, mark the tool as strict for structured tool use validation

defer_loading: Option<bool>

When true, the tool is deferred and only loaded when discovered via tool search (Anthropic advanced-tool-use beta) This enables dynamic tool discovery for large tool catalogs (10k+ tools)

Implementations

impl ToolDefinition

pub fn function(name: String, description: String, parameters: Value) -> Self

Create a new tool definition with function type

pub fn with_strict(self, strict: bool) -> Self

Set whether the tool should be considered strict (Anthropic structured tool use)

pub fn with_allowed_callers(self, allowed_callers: Vec<String>) -> Self

Restrict which Anthropic callers can invoke this tool programmatically.

pub fn with_input_examples(self, input_examples: Vec<Value>) -> Self

Attach Anthropic tool use examples for better tool selection and argument shaping.

pub fn with_defer_loading(self, defer: bool) -> Self

Set whether the tool should be deferred (Anthropic tool search)

pub fn tool_search(algorithm: ToolSearchAlgorithm) -> Self

Create a tool search tool definition for Anthropic’s advanced-tool-use beta Supports regex and bm25 search algorithms

pub fn hosted_tool_search() -> Self

Create an OpenAI hosted tool search definition.

pub fn anthropic_memory() -> Self

Create an Anthropic native memory tool definition.

pub fn apply_patch(description: String) -> Self

Create a new apply_patch tool definition (GPT-5.1 specific) The apply_patch tool lets models create, update, and delete files using VT Code structured diffs

pub fn custom(name: String, description: String) -> Self

Create a new custom tool definition for freeform function calling (GPT-5 specific) Allows raw text payloads without JSON wrapping

pub fn grammar(syntax: String, definition: String) -> Self

Create a new grammar tool definition for context-free grammar constraints (GPT-5 specific) Ensures model output matches predefined syntax

pub fn web_search(config: Value) -> Self

Create a provider-native web search tool definition.

pub fn google_maps(config: Value) -> Self

Create a Gemini Google Maps grounding tool definition.

pub fn url_context(config: Value) -> Self

Create a Gemini URL Context tool definition.

pub fn file_search(config: Value) -> Self

Create an OpenAI Responses file search tool definition.

pub fn code_execution(config: Value) -> Self

Create a Gemini Code Execution tool definition.

pub fn mcp(config: Value) -> Self

Create an OpenAI Responses remote MCP tool definition.

pub fn function_name(&self) -> &str

Get the function name for easy access

pub fn description(&self) -> &str

Get the description for easy access

pub fn validate(&self) -> Result<(), String>

Validate that this tool definition is properly formed

pub fn is_tool_search(&self) -> bool

Returns true if this is a tool search tool type

pub fn is_anthropic_web_search(&self) -> bool

Returns true when the tool is an Anthropic native web search tool revision.

pub fn is_anthropic_code_execution(&self) -> bool

Returns true when the tool is an Anthropic native code execution tool revision.

pub fn is_anthropic_memory_tool(&self) -> bool

Returns true when the tool is an Anthropic native memory tool revision.

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for ToolDefinition