Enum Tool 

pub enum Tool {
    Function {
        function: FunctionDefinition,
    },
    WebSearch {
        filters: Option<WebSearchFilters>,
        enable_image_understanding: Option<bool>,
    },
    XSearch {
        allowed_x_handles: Option<Vec<String>>,
        excluded_x_handles: Option<Vec<String>>,
        from_date: Option<String>,
        to_date: Option<String>,
        enable_image_understanding: Option<bool>,
        enable_video_understanding: Option<bool>,
    },
    CodeInterpreter {},
    CollectionsSearch {
        collection_ids: Option<Vec<String>>,
    },
    Mcp {
        server: McpServer,
        allowed_tools: Option<Vec<String>>,
    },
}

A tool that can be used by the model.

Variants

Function

A custom function tool.

Fields

function: FunctionDefinition

The function definition.

WebSearch

Web search tool.

Fields

filters: Option<WebSearchFilters>

Search filters.

enable_image_understanding: Option<bool>

Enable image understanding during search.

XSearch

X (Twitter) search tool.

Fields

allowed_x_handles: Option<Vec<String>>

Allowed X handles.

excluded_x_handles: Option<Vec<String>>

Excluded X handles.

from_date: Option<String>

Start date for search (YYYY-MM-DD).

to_date: Option<String>

End date for search (YYYY-MM-DD).

enable_image_understanding: Option<bool>

Enable image understanding.

enable_video_understanding: Option<bool>

Enable video understanding.

CodeInterpreter

Code interpreter tool.

CollectionsSearch

Collections search tool.

Fields

collection_ids: Option<Vec<String>>

Collection IDs to search.

Mcp

Remote MCP server tool.

Fields

server: McpServer

MCP server configuration.

allowed_tools: Option<Vec<String>>

Specific tools to enable.

Implementations

impl Tool

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

Create a function tool.

pub fn web_search() -> Self

Create a web search tool with default settings.

pub fn web_search_filtered(filters: WebSearchFilters) -> Self

Create a web search tool with filters.

pub fn x_search() -> Self

Create an X search tool with default settings.

pub fn code_interpreter() -> Self

Create a code interpreter tool.

pub fn collections_search(collection_ids: Vec<String>) -> Self

Create a collections search tool.

pub fn mcp(server_url: impl Into<String>) -> Self

Create an MCP tool.

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Tool

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

where __S: Serializer,

Serialize this value into the given Serde serializer.