Struct ReadFile 

pub struct ReadFile { /* private fields */ }

Read a UTF-8 text file.

Unsandboxed by default. Without ReadFile::with_sandbox this tool can read any file the process has access to. Pair with a FilesystemRoot when exposing to untrusted LLM output.

Implementations

impl ReadFile

pub fn new() -> Self

Unsandboxed constructor — full-host read access. Use only in trusted contexts.

pub fn with_sandbox(sandbox: Arc<FilesystemRoot>) -> Self

Sandboxed constructor — paths are resolved against sandbox and rejected if they escape the root.

Trait Implementations

impl Default for ReadFile

fn default() -> Self

Returns the “default value” for a type.

impl Tool for ReadFile

fn name(&self) -> &str

The tool’s name — used by the model to invoke it and for dispatch.

fn description(&self) -> &str

Human-readable description sent to the model as part of the tool list. This is the primary steering mechanism for tool selection.

fn schema(&self) -> Value

JSON Schema describing the tool’s arguments.

fn call(&self, args: Value) -> Result<String, String>

Execute the tool synchronously. Return a string result or an error message. Callers must enforce result-byte caps and envelope framing before persisting or feeding back to the model.