Enum ToolInput 

pub enum ToolInput {
    Edit(EditInput),
    Write(WriteInput),
    MultiEdit(MultiEditInput),
    AskUserQuestion(AskUserQuestionInput),
    TodoWrite(TodoWriteInput),
    Task(TaskInput),
    NotebookEdit(NotebookEditInput),
    WebFetch(WebFetchInput),
    TaskOutput(TaskOutputInput),
    Bash(BashInput),
    Read(ReadInput),
    Glob(GlobInput),
    Grep(GrepInput),
    ToolSearch(ToolSearchInput),
    WebSearch(WebSearchInput),
    KillShell(KillShellInput),
    Skill(SkillInput),
    ExitPlanMode(ExitPlanModeInput),
    ScheduleWakeup(ScheduleWakeupInput),
    NotebookRead(NotebookReadInput),
    LS(LsInput),
    EnterPlanMode(EnterPlanModeInput),
    Unknown(Value),
}

Unified enum representing input for any Claude Code tool.

This enum uses #[serde(untagged)] to automatically deserialize based on the structure of the JSON. The Unknown variant serves as a fallback for:

• New tools added in future Claude CLI versions
• Custom MCP tools provided by users
• Any tool input that doesn’t match known schemas

Example

use claude_codes::ToolInput;

// Known tool - deserializes to specific variant
let bash_json = serde_json::json!({"command": "ls"});
let input: ToolInput = serde_json::from_value(bash_json).unwrap();
assert!(matches!(input, ToolInput::Bash(_)));

// Unknown tool - falls back to Unknown variant
let custom_json = serde_json::json!({"custom_field": "value"});
let input: ToolInput = serde_json::from_value(custom_json).unwrap();
assert!(matches!(input, ToolInput::Unknown(_)));

Note on Ordering

The variants are ordered from most specific (most required fields) to least specific to ensure correct deserialization with #[serde(untagged)].

Variants

Edit(EditInput)

Edit tool - has unique field combination (file_path, old_string, new_string)

Write(WriteInput)

Write tool - file_path + content

MultiEdit(MultiEditInput)

MultiEdit tool - batch file edits (file_path + edits, before Read)

AskUserQuestion(AskUserQuestionInput)

AskUserQuestion tool - has questions array

TodoWrite(TodoWriteInput)

TodoWrite tool - has todos array

Task(TaskInput)

Task tool - description + prompt + subagent_type

NotebookEdit(NotebookEditInput)

NotebookEdit tool - notebook_path + new_source

WebFetch(WebFetchInput)

WebFetch tool - url + prompt

TaskOutput(TaskOutputInput)

TaskOutput tool - task_id + block + timeout

Bash(BashInput)

Bash tool - has command field

Read(ReadInput)

Read tool - has file_path

Glob(GlobInput)

Glob tool - has pattern field (with deny_unknown_fields, must come before Grep)

Grep(GrepInput)

Grep tool - has pattern field plus many optional fields

ToolSearch(ToolSearchInput)

ToolSearch tool - fetch deferred tool schemas (query + max_results)

WebSearch(WebSearchInput)

WebSearch tool - has query field

KillShell(KillShellInput)

KillShell tool - has shell_id

Skill(SkillInput)

Skill tool - has skill field

ExitPlanMode(ExitPlanModeInput)

ExitPlanMode tool

ScheduleWakeup(ScheduleWakeupInput)

ScheduleWakeup tool - schedule delayed wakeup (3 required fields)

NotebookRead(NotebookReadInput)

NotebookRead tool - read notebook cells (notebook_path required)

LS(LsInput)

LS tool - list files and directories

EnterPlanMode(EnterPlanModeInput)

EnterPlanMode tool (empty input)

Unknown(Value)

Unknown tool input - fallback for custom/new tools

This variant captures any tool input that doesn’t match the known schemas. Use this for:

• MCP tools provided by users
• New tools in future Claude CLI versions
• Any custom tool integration

Implementations

impl ToolInput

pub fn tool_name(&self) -> Option<&'static str>

Returns the tool name if it can be determined from the input type.

For Unknown variants, returns None since the tool name cannot be determined from the input structure alone.

pub fn from_named_input(name: &str, input: Value) -> Self

Parse a tool-use input payload using the authoritative tool name from the surrounding ToolUse block, instead of guessing the variant from field shape.

The Deserialize impl for ToolInput is #[serde(untagged)], so it resolves variants by structural shape in declaration order. Tools whose inputs are structurally identical are therefore genuinely ambiguous to the untagged impl — most notably WebSearch and ToolSearch, which both deserialize cleanly from a bare { "query": String }, so the first-declared variant wins and the other is never produced. The tool name disambiguates them.

Falls back to ToolInput::Unknown when the named struct doesn’t deserialize, and defers to the untagged Deserialize impl for tool names this crate doesn’t model (e.g. MCP tools).

Examples

use claude_codes::ToolInput;

// A bare-query WebSearch input — ambiguous to the untagged impl, which
// would pick `ToolSearch`. The name resolves it correctly.
let input = serde_json::json!({ "query": "rust async" });
let parsed = ToolInput::from_named_input("WebSearch", input);
assert!(matches!(parsed, ToolInput::WebSearch(_)));

pub fn as_bash(&self) -> Option<&BashInput>

Try to get the input as a Bash input.

pub fn as_read(&self) -> Option<&ReadInput>

Try to get the input as a Read input.

pub fn as_write(&self) -> Option<&WriteInput>

Try to get the input as a Write input.

pub fn as_edit(&self) -> Option<&EditInput>

Try to get the input as an Edit input.

pub fn as_glob(&self) -> Option<&GlobInput>

Try to get the input as a Glob input.

pub fn as_grep(&self) -> Option<&GrepInput>

Try to get the input as a Grep input.

pub fn as_task(&self) -> Option<&TaskInput>

Try to get the input as a Task input.

pub fn as_web_fetch(&self) -> Option<&WebFetchInput>

Try to get the input as a WebFetch input.

pub fn as_web_search(&self) -> Option<&WebSearchInput>

Try to get the input as a WebSearch input.

pub fn as_todo_write(&self) -> Option<&TodoWriteInput>

Try to get the input as a TodoWrite input.

pub fn as_ask_user_question(&self) -> Option<&AskUserQuestionInput>

Try to get the input as an AskUserQuestion input.

pub fn as_notebook_edit(&self) -> Option<&NotebookEditInput>

Try to get the input as a NotebookEdit input.

pub fn as_task_output(&self) -> Option<&TaskOutputInput>

Try to get the input as a TaskOutput input.

pub fn as_kill_shell(&self) -> Option<&KillShellInput>

Try to get the input as a KillShell input.

pub fn as_skill(&self) -> Option<&SkillInput>

Try to get the input as a Skill input.

pub fn as_unknown(&self) -> Option<&Value>

Try to get the input as an unknown Value.

pub fn is_unknown(&self) -> bool

Check if this is an unknown tool input.

Trait Implementations

impl Clone for ToolInput

fn clone(&self) -> ToolInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolInput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AskUserQuestionInput> for ToolInput

fn from(input: AskUserQuestionInput) -> Self

Converts to this type from the input type.

impl From<BashInput> for ToolInput

fn from(input: BashInput) -> Self

Converts to this type from the input type.

impl From<EditInput> for ToolInput

fn from(input: EditInput) -> Self

Converts to this type from the input type.

impl From<GlobInput> for ToolInput

fn from(input: GlobInput) -> Self

Converts to this type from the input type.

impl From<GrepInput> for ToolInput

fn from(input: GrepInput) -> Self

Converts to this type from the input type.

impl From<ReadInput> for ToolInput

fn from(input: ReadInput) -> Self

Converts to this type from the input type.

impl From<TaskInput> for ToolInput

fn from(input: TaskInput) -> Self

Converts to this type from the input type.

impl From<TodoWriteInput> for ToolInput

fn from(input: TodoWriteInput) -> Self

Converts to this type from the input type.

impl From<WebFetchInput> for ToolInput

fn from(input: WebFetchInput) -> Self

Converts to this type from the input type.

impl From<WebSearchInput> for ToolInput

fn from(input: WebSearchInput) -> Self

Converts to this type from the input type.

impl From<WriteInput> for ToolInput

fn from(input: WriteInput) -> Self

Converts to this type from the input type.

impl PartialEq for ToolInput

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolInput