Struct ToolContext 

pub struct ToolContext {
    pub working_dir: String,
    pub session_id: Option<String>,
    pub sandbox: SandboxSettings,
    pub network: NetworkPolicy,
    pub file_claims: Option<FileClaimRegistry>,
    pub agent_id: Option<String>,
    pub agent_label: Option<String>,
    pub file_index: Option<Arc<WorkspaceIndex>>,
    pub panel: Option<PanelSink>,
    pub todo_sink: Option<TodoSink>,
    pub swarm_hub: Option<SwarmHub>,
}

Context passed to tool execution

Fields

working_dir: String

session_id: Option<String>

sandbox: SandboxSettings

OS sandbox policy for shell tools (ignored by pure file tools).

network: NetworkPolicy

Domain allow/deny for HTTP tools (webfetch, websearch, GitHub API).

file_claims: Option<FileClaimRegistry>

When set (swarm workers), file mutators claim paths before writing.

agent_id: Option<String>

Stable agent id for file claims (e.g. worker-0). Required with file_claims.

agent_label: Option<String>

Display label for conflict messages (defaults to agent_id).

file_index: Option<Arc<WorkspaceIndex>>

Resident workspace file index (when the host started one). File tools use it as a warm fast path for enumeration and fall back to walking.

panel: Option<PanelSink>

Optional sink so the panel tool can pin a file / diff / mermaid.

todo_sink: Option<TodoSink>

Optional sink so todowrite can update the host todo panel live.

swarm_hub: Option<SwarmHub>

Swarm mailbox (DM / broadcast).

Implementations

impl ToolContext

pub fn new(working_dir: impl Into<String>) -> Self

pub fn unsandboxed(working_dir: impl Into<String>) -> Self

pub fn check_file_write(&self, path: &Path) -> Result<(), String>

Gate a file write/edit against the shared claim registry.

No-op when claims are not active (normal single-agent turns). On conflict returns an error string suitable for ToolResult.content.

pub fn check_file_read(&self, path: &Path) -> Option<FileStaleEvent>

After a successful read, note the path. Returns a stale-read event when another agent wrote the file since this reader last saw it.

Trait Implementations

impl Clone for ToolContext

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolContext

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

Formats the value using the given formatter.