Enum ToolMetadata 

pub enum ToolMetadata {
    None,
    ReadFile {
        paths: Vec<String>,
        line_count: usize,
        byte_count: usize,
        truncated: bool,
    },
    WriteFile {
        path: String,
        line_count: usize,
        byte_count: usize,
        created: Option<bool>,
    },
    ApplyPatch {
        added: Vec<String>,
        modified: Vec<String>,
        deleted: Vec<String>,
        renamed: Vec<(String, String)>,
        fuzzy: bool,
    },
    DeleteFile {
        path: String,
    },
    CreateDirectory {
        path: String,
    },
    WebSearch {
        queries: Vec<String>,
        requested_count: usize,
        result_count: usize,
        sources: Vec<String>,
    },
    WebFetch {
        url: String,
        title: Option<String>,
        line_count: usize,
        byte_count: usize,
    },
    ExecuteCommand {
        command: String,
        working_dir: Option<String>,
        exit_code: Option<i32>,
        timed_out: bool,
        background: bool,
        stdout_lines: usize,
        stderr_lines: usize,
        detected_urls: Vec<String>,
        pid: Option<u32>,
        log_path: Option<String>,
        denied_by_sandbox: bool,
    },
    ComputerUse {
        action: String,
        params: Value,
    },
    Mcp {
        server: String,
        tool: String,
    },
    Subagent {
        model_id: String,
        agent_id: String,
    },
    Tasks {
        action: String,
        completed: u32,
        total: u32,
    },
    Questions {
        answers: Vec<QuestionAnswer>,
        remembered: bool,
    },
    Plan {
        path: String,
        body: String,
        start: bool,
        fresh: bool,
        fork: bool,
        model: Option<String>,
    },
    Custom {
        name: String,
        data: Value,
    },
}

Typed metadata produced by a specific tool implementation.

Variants

None

ReadFile

Fields

paths: Vec<String>

line_count: usize

byte_count: usize

truncated: bool

WriteFile

Fields

path: String

line_count: usize

byte_count: usize

created: Option<bool>

ApplyPatch

Fields

added: Vec<String>

modified: Vec<String>

deleted: Vec<String>

renamed: Vec<(String, String)>

fuzzy: bool

DeleteFile

Fields

path: String

CreateDirectory

Fields

path: String

WebSearch

Fields

queries: Vec<String>

requested_count: usize

result_count: usize

sources: Vec<String>

WebFetch

Fields

url: String

title: Option<String>

line_count: usize

byte_count: usize

ExecuteCommand

Fields

command: String

working_dir: Option<String>

exit_code: Option<i32>

timed_out: bool

background: bool

stdout_lines: usize

stderr_lines: usize

detected_urls: Vec<String>

pid: Option<u32>

log_path: Option<String>

denied_by_sandbox: bool

The command was terminated by the OS sandbox (e.g. it tried to reach the network under --no-network). Additive; #[serde(default)] keeps older recordings/rows deserializable.

ComputerUse

Fields

action: String

params: Value

Mcp

Fields

server: String

tool: String

Subagent

Fields

model_id: String

agent_id: String

Continuation handle: pass back via the agent tool’s agent_id arg to send a follow-up prompt to this child with its context intact. Empty on recordings from before continuations existed.

Tasks

The task checklist tools (task_create / task_update / task_list). action is the wire tool suffix (“create” / “update” / “list”); counts are over visible (non-deleted) tasks after the call.

Fields

action: String

completed: u32

total: u32

Questions

ask_user_question resolved with answers. Kept structured so the transcript can replay each question → answer pair rather than a bare duration.

Fields

answers: Vec<QuestionAnswer>

remembered: bool

The answers came from remembered cross-session preferences (memoryKey) rather than a live prompt.

Plan

exit_plan_mode resolved with an APPROVED plan: the transcript renders the plan body as a markdown block, and handle_tool_finished keys the post-approval mechanics (clear session.plan, seed the checklist, optionally auto-submit) on this variant. A request-for-changes outcome carries no metadata.

Fields

path: String

Plan-file path as shown to the user (project-relative).

body: String

The approved plan text, re-read from disk at approval time.

start: bool

True when the user chose to start implementing immediately.

fresh: bool

Execution begins in a FRESH conversation seeded with the handoff preamble + plan (clear-context execute, or a fresh-session handoff). The exploration context is left behind on disk.

fork: bool

Handoff variant that copies the transcript into a new conversation before starting (mutually exclusive with fresh).

model: Option<String>

Handoff: switch the session to this model for execution.

Custom

Fields

name: String

data: Value

Trait Implementations

impl Clone for ToolMetadata

fn clone(&self) -> ToolMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolMetadata

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

Formats the value using the given formatter.

impl Default for ToolMetadata

fn default() -> ToolMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolMetadata

fn eq(&self, other: &ToolMetadata) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ToolMetadata

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 ToolMetadata