Struct FileReadTool 

pub struct FileReadTool;

Trait Implementations

impl Tool for FileReadTool

fn name(&self) -> &'static str

Unique tool name used in API tool_use blocks.

fn description(&self) -> &'static str

Human-readable description sent to the LLM.

fn input_schema(&self) -> Value

JSON Schema for the tool’s input parameters.

fn is_read_only(&self) -> bool

Whether this tool only reads state (no mutations).

fn is_concurrency_safe(&self) -> bool

Whether this tool can safely run concurrently with other tools. Read-only tools are typically concurrency-safe.

fn get_path(&self, input: &Value) -> Option<PathBuf>

Extract a file path from the input, if applicable (for permission matching).

fn call<'life0, 'life1, 'async_trait>( &'life0 self, input: Value, _ctx: &'life1 ToolContext, ) -> Pin<Box<dyn Future<Output = Result<ToolResult, ToolError>> + Send + 'async_trait>>

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

Execute the tool with validated input.

fn prompt(&self) -> String

System prompt instructions for this tool.

fn is_destructive(&self) -> bool

Whether this tool is destructive (deletes data, force-pushes, etc.).

fn is_enabled(&self) -> bool

Whether this tool is currently enabled in the environment.

fn max_result_size_chars(&self) -> usize

Maximum result size in characters before truncation.

fn check_permissions<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, input: &'life1 Value, checker: &'life2 PermissionChecker, ) -> Pin<Box<dyn Future<Output = PermissionDecision> + Send + 'async_trait>>

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

Check permissions for executing this tool with the given input.

fn validate_input(&self, _input: &Value) -> Result<(), String>

Validate tool input before execution.