Struct ExternalTool 

pub struct ExternalTool {
    pub name: String,
    pub description: String,
    pub parameters: Value,
    pub is_final: bool,
    pub prompt: Option<String>,
}

External tool that delegates execution to the frontend

Fields

name: String

description: String

parameters: Value

is_final: bool

prompt: Option<String>

Detailed usage instructions injected into the system prompt.

Trait Implementations

impl Clone for ExternalTool

fn clone(&self) -> ExternalTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for ExternalTool

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

impl Debug for ExternalTool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExternalTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ExternalTool

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

fn eq(&self, other: &ExternalTool) -> 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 ExternalTool

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 ExternalTool

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.

impl Tool for ExternalTool

fn get_name(&self) -> String

fn get_description(&self) -> String

fn get_parameters(&self) -> Value

fn is_external(&self) -> bool

Check if this tool is external (handled by frontend)

fn is_final(&self) -> bool

fn prompt(&self) -> Option<String>

Optional detailed prompt/instructions for this tool. When provided, these instructions are injected into the system prompt so the LLM knows HOW to use the tool (not just what parameters it takes). This mirrors claude-code’s per-tool prompt() pattern.

fn execute<'life0, 'async_trait>( &'life0 self, _tool_call: ToolCall, _context: Arc<ToolContext>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Part>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the tool with given arguments, returning content parts

fn get_tool_definition(&self) -> ToolDefinition

Get the tool definition for the LLM

fn get_tool_examples(&self) -> Option<String>

fn is_mcp(&self) -> bool

Check if this tool is an MCP tool

fn is_sync(&self) -> bool

fn needs_executor_context(&self) -> bool

Check if this tool needs ExecutorContext instead of ToolContext

fn get_auth_metadata(&self) -> Option<Box<dyn AuthMetadata>>

Get authentication metadata for this tool

fn get_plugin_name(&self) -> Option<String>

Get the plugin name this tool belongs to (nullable) If this returns Some, the tool is part of a plugin If None, the tool is standalone

fn execute_sync( &self, _tool_call: ToolCall, _context: Arc<ToolContext>, ) -> Result<Vec<Part>, Error>

Synchronous execution of the tool, returning content parts (default unsupported)

impl StructuralPartialEq for ExternalTool