Struct Tool 

pub struct Tool {
    pub description: String,
    pub instructions: Option<String>,
    pub name: String,
    pub namespaced_name: Option<String>,
    pub parameters: Option<HashMap<String, Value>>,
    pub safe_for_telemetry: Option<Value>,
}

Built-in tool metadata with identifier, optional namespaced name, description, input-parameter schema, and usage instructions.

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

Description of what the tool does

instructions: Option<String>

Optional instructions for how to use this tool effectively

name: String

Tool identifier (e.g., “bash”, “grep”, “str_replace_editor”)

namespaced_name: Option<String>

Optional namespaced name for declarative filtering (e.g., “playwright/navigate” for MCP tools)

parameters: Option<HashMap<String, Value>>

JSON Schema for the tool’s input parameters

safe_for_telemetry: Option<Value>

Telemetry-safety policy for the tool name and input names, not input values. Treat omitted metadata as unsafe.

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

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Self

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 Default for Tool

fn default() -> Self

Returns the “default value” for a type.

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.