Struct Read 

pub struct Read { /* private fields */ }

The read tool.

Implementations

impl Read

pub fn new(env: ToolEnv) -> Read

A read tool for env.

Trait Implementations

impl Tool for Read

fn declaration(&self) -> &ToolDeclaration

Name, description and argument schema as sent to the model.

fn execute( &self, _call_id: String, args: Value, cancel: CancellationToken, _updates: UpdateSink, ) -> BoxFuture<'_, Result<ToolResult, String>>

Runs the tool with validated arguments.

fn label(&self) -> &str

Human-readable name for the UI.

fn execution_mode(&self) -> ExecutionMode

See ExecutionMode.

fn output_schema(&self) -> Option<&Value>

JSON Schema of the value the tool returns as structuredContent, for tools whose results scripts consume (pi’s outputSchema).

fn prepare_arguments(&self, arguments: Map<String, Value>) -> Map<String, Value>

Rewrites raw arguments before validation, for compatibility with older argument shapes.