Struct ReadFileTool 

pub struct ReadFileTool;

Read a file with optional line offset and limit. Returns line-numbered text so the model can reference specific lines in subsequent edits. Read-only.

Trait Implementations

impl ToolLike for ReadFileTool

fn name(&self) -> &str

Unique name the model uses to call the tool.

fn description(&self) -> &str

Human-readable description shown to the model.

fn input_schema(&self) -> Value

JSON Schema describing the tool’s arguments.

fn is_read_only(&self) -> bool

Whether this tool has no side effects. Read-only tools in the same turn run concurrently; non-read-only tools run serially. Default: false.

fn call<'a>( &'a self, input: Value, ctx: &'a ToolContext, ) -> Pin<Box<dyn Future<Output = ProviderResult<ToolResult>> + Send + 'a>>

Run the tool. The future is held by the agent loop and dropped on cancellation; pair long-running work with ToolContext::wait_for_cancel in a tokio::select! to drop the losing branch promptly.

fn should_defer(&self) -> bool

Whether the tool’s full definition is hidden until it is discovered via ToolSearchTool. Deferred tools appear to the model as name-only stubs. Default: false.