Struct ReadFileTool 

pub struct ReadFileTool { /* private fields */ }

Reads a UTF-8 text file, optionally limited to a 1-based inclusive line range.

Tool name: fs.read_file

When FileSystemToolResources is available in the tool context, a successful read marks the path as inspected for the current session.

Example

use agentkit_tool_fs::ReadFileTool;
use agentkit_tools_core::Tool;

let tool = ReadFileTool::default();
assert_eq!(&tool.spec().name.0, "fs.read_file");

Trait Implementations

impl Clone for ReadFileTool

fn clone(&self) -> ReadFileTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadFileTool

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

Formats the value using the given formatter.

impl Default for ReadFileTool

fn default() -> Self

Returns the “default value” for a type.

impl Tool for ReadFileTool

fn spec(&self) -> &ToolSpec

Returns the static specification for this tool.

fn proposed_requests( &self, request: &ToolRequest, ) -> Result<Vec<Box<dyn PermissionRequest>>, ToolError>

Returns permission requests the executor should evaluate before calling invoke.

fn invoke<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, request: ToolRequest, ctx: &'life1 mut ToolContext<'life2>, ) -> Pin<Box<dyn Future<Output = Result<ToolResult, ToolError>> + Send + 'async_trait>>

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

Executes the tool and returns a result or error.

fn current_spec(&self) -> Option<ToolSpec>

Returns the current specification for this tool, if it should be advertised right now.