Struct ReadTool 

pub struct ReadTool { /* private fields */ }

ReadTool.

Implementations

impl ReadTool

pub fn new() -> Self

Create with no explicit root (uses ToolContext.workspace_dir at runtime).

pub fn with_cwd(cwd: PathBuf) -> Self

Create with a specific working directory (overrides ToolContext).

Trait Implementations

impl AgentTool for ReadTool

fn name(&self) -> &str

Tool name (used in function calls)

fn label(&self) -> &str

Human-readable label

fn essential(&self) -> bool

Whether this tool is essential (cannot be disabled). Essential tools: read, write, edit, bash, grep, find, ls Optional tools: web_search, github, subagent, etc.

fn description(&self) -> &str

Description for the model

fn parameters_schema(&self) -> Value

JSON Schema for parameters

fn execute<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _tool_call_id: &'life1 str, params: Value, _signal: Option<Receiver<()>>, ctx: &'life2 ToolContext, ) -> Pin<Box<dyn Future<Output = Result<AgentToolResult, ToolError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Execute the tool with the given tool call ID and parameters.

fn on_progress(&self, callback: ProgressCallback)

Called with progress updates during execution. Tools can override this to emit streaming updates.

fn to_definition(&self) -> ToolDefinition

Convert to ToolDefinition

impl Default for ReadTool

fn default() -> Self

Returns the “default value” for a type.