Struct EnterPlanModeTool 

pub struct EnterPlanModeTool { /* private fields */ }

Tool that switches the agent into read-only planning mode.

Once entered, any non-readonly tool call (except exit_plan_mode) is blocked with an error message. The agent should use read tools to explore the codebase, then call exit_plan_mode with its markdown plan.

When a PermissionsConfig is provided, the tool also checks which tools are in Plan mode and includes that information in the response, guiding the agent to focus on those tools during planning.

Implementations

impl EnterPlanModeTool

pub fn new(gate: Arc<PlanApprovalGate>) -> Self

Create a new EnterPlanModeTool sharing the given gate.

pub fn with_permissions(self, permissions: Arc<PermissionsConfig>) -> Self

Attach a permissions config so the tool can report which tools are in Plan mode.

Trait Implementations

impl Tool for EnterPlanModeTool

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