Enum Tool 

pub enum Tool {
    AskUserQuestion,
    EnterPlanMode,
    ExitPlanMode,
    Bash,
    Read,
    Write,
    Edit,
    Grep,
    Glob,
    Task,
    WebSearch,
    WebFetch,
    TodoWrite,
    NotebookEdit,
    NotebookRead,
    Other(String),
}

A tool an agent can invoke.

Variants are limited to tools the daemon special-cases (interactive permission-gated tools, common tools we render with a friendlier label). Everything else lives in Other(String) and round-trips losslessly.

Variants

AskUserQuestion

AskUserQuestion — pauses and prompts the user.

EnterPlanMode

EnterPlanMode — pauses for plan approval.

ExitPlanMode

ExitPlanMode — pauses presenting the plan.

Bash

Read

Write

Edit

Grep

Glob

Task

WebSearch

WebFetch

TodoWrite

NotebookEdit

NotebookRead

Other(String)

Any other tool name — MCP tools, vendor-specific tools, future well-known tools we haven’t promoted to a variant yet.

Implementations

impl Tool

pub fn is_interactive(&self) -> bool

True for tools whose PreToolUse event means the session is awaiting user input rather than running.

Adapter authors: this classification is Claude-driven today (pi has no equivalent event — its permission gating is extension- mediated and surfaces via NeedsInputReason::PermissionGate). If a vendor’s tool genuinely blocks waiting on user input, promote it to a variant rather than relying on string matching.

pub fn as_str(&self) -> &str

Canonical wire-format string for this 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 Display for Tool

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

Formats the value using the given formatter.

impl From<&str> for Tool

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Tool

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Tool> for String

fn from(t: Tool) -> Self

Converts to this type from the input type.

impl Hash for Tool

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Tool

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Tool

impl StructuralPartialEq for Tool