Struct BuiltinToolDescriptor 

pub struct BuiltinToolDescriptor {
    pub description: String,
    pub format: Option<BuiltinToolFormat>,
    pub has_summarise_intention: bool,
    pub input_schema: Option<BuiltinToolInputSchema>,
    pub instructions: Option<String>,
    pub is_terminal: bool,
    pub name: String,
    pub safe_for_telemetry: Value,
    pub title: Option<String>,
    pub type: Option<String>,
}

Rust-owned metadata and input schema for a built-in tool.

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

Fields

description: String

Model-facing description of the tool’s behavior.

format: Option<BuiltinToolFormat>

Optional custom input format used instead of a JSON Schema.

has_summarise_intention: bool

Whether the tool provides a specialized intention summary.

input_schema: Option<BuiltinToolInputSchema>

JSON Schema for the tool input, or null when the tool uses a custom format.

instructions: Option<String>

Optional supplemental usage instructions for the tool.

is_terminal: bool

Whether the tool executes commands in a terminal.

name: String

Stable name used to invoke the built-in tool.

safe_for_telemetry: Value

Policy describing which tool metadata may be recorded without obfuscation.

title: Option<String>

Optional human-readable title for the tool.

type: Option<String>

Optional tool category discriminator.

Trait Implementations

impl Clone for BuiltinToolDescriptor

fn clone(&self) -> BuiltinToolDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuiltinToolDescriptor

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

Formats the value using the given formatter.

impl Default for BuiltinToolDescriptor

fn default() -> BuiltinToolDescriptor

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BuiltinToolDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BuiltinToolDescriptor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.