Struct WatchFile 

pub struct WatchFile { /* private fields */ }

The watch_file tool: register a file for event-driven wakes.

Implementations

impl WatchFile

pub fn new( root: impl Into<PathBuf>, manager: Arc<Mutex<BackgroundJobManager>>, ) -> Self

Trait Implementations

impl Tool for WatchFile

fn spec(&self) -> ToolSpec

fn is_deferred(&self) -> bool

Return true to send this tool as deferred (name-only) in the initial prompt; the model must call ToolSearch to load its full schema. Default is false (eager). Override in low-frequency tools.

fn execute<'life0, 'async_trait>( &'life0 self, args: Value, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

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

fn side_effect_class(&self) -> ToolSideEffect

Classify this tool’s observable side-effects. Default is the most conservative value (External) so any unannotated tool is treated as risky on resume. Override to ReadOnly or Mutating for built-in tools; MCP tools derive this from their annotations.

fn kind(&self) -> ToolKind

Return the ACP ToolKind for tool_call notifications (Sprint 3). Defaults to ToolKind::Other. Concrete tools override to map to their corresponding ACP category.

fn is_readonly(&self) -> bool

Convenience: a tool is read-only iff it classifies as ReadOnly. Used by the parallel-dispatch path in agent.rs. Override only if you have an unusual reason (you almost never should — override side_effect_class instead and let this default through).

fn is_readonly_for_args(&self, _arguments: &Value) -> bool

Like is_readonly but can inspect the call-time arguments.