Struct ProtocolExternalToolDefinition 

pub struct ProtocolExternalToolDefinition {
    pub defer: Option<ProtocolExternalToolDefer>,
    pub description: String,
    pub is_terminal: Option<bool>,
    pub metadata: Option<HashMap<String, Value>>,
    pub name: String,
    pub overrides_built_in_tool: Option<bool>,
    pub parameters: Option<HashMap<String, Value>>,
    pub skip_permission: Option<bool>,
    pub title: Option<String>,
}

Serializable definition of a caller-implemented tool whose execution is handled over the SDK connection.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields

defer: Option<ProtocolExternalToolDefer>

Tool-loading deferral policy.

description: String

Model-visible explanation of what the tool does.

is_terminal: Option<bool>

Whether the tool executes commands in a terminal.

metadata: Option<HashMap<String, Value>>

Optional caller-defined metadata associated with the tool.

name: String

Unique model-visible tool name.

overrides_built_in_tool: Option<bool>

Whether this definition replaces a built-in tool with the same name.

parameters: Option<HashMap<String, Value>>

JSON Schema describing the tool’s input arguments.

skip_permission: Option<bool>

Whether execution bypasses the normal tool permission prompt.

title: Option<String>

Optional human-readable display title.

Trait Implementations

impl Clone for ProtocolExternalToolDefinition

fn clone(&self) -> ProtocolExternalToolDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolExternalToolDefinition

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

Formats the value using the given formatter.

impl Default for ProtocolExternalToolDefinition

fn default() -> ProtocolExternalToolDefinition

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProtocolExternalToolDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProtocolExternalToolDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.