Struct ClientWriteFile 

pub struct ClientWriteFile {
    pub extra_roots: Vec<(PathBuf, AccessTier)>,
    pub session_roots: Option<SharedSandboxRoots>,
    /* private fields */
}

A tool that writes content to the ACP client’s buffer (IDE/editor).

The agent calls this when the client has declared fs.writeTextFile=true. The tool sends the file path and content to the client, which updates its unsaved buffer without writing to disk.

Sandbox escape detection is enforced: the file_path parameter is checked against the sandbox roots via resolve_within before the write is sent to the client (S2-E5).

Fields

extra_roots: Vec<(PathBuf, AccessTier)>

Additional sandbox roots beyond the primary workspace.

session_roots: Option<SharedSandboxRoots>

Session-scoped, runtime-mutable roots.

Implementations

impl ClientWriteFile

pub fn new(workspace: &Path) -> Self

Create a new ClientWriteFile tool.

pub fn with_acp_state(self, state: Arc<Mutex<AcpClientFsState>>) -> Self

Set the shared ACP client FS state.

pub fn with_extra_roots( self, extra: impl IntoIterator<Item = (PathBuf, AccessTier)>, ) -> Self

Append additional allowed sandbox roots.

pub fn with_session_roots_opt(self, slot: Option<SharedSandboxRoots>) -> Self

Convenience: attach the shared slot only when Some.

Trait Implementations

impl Tool for ClientWriteFile

fn spec(&self) -> ToolSpec

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

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

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 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 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 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.