Struct EnterPlanModeTool 

pub struct EnterPlanModeTool { /* private fields */ }

Tool for entering plan mode

Implementations

impl EnterPlanModeTool

pub fn new(state: PlanModeState) -> Self

Trait Implementations

impl Tool for EnterPlanModeTool

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

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

Execute the tool with given arguments

fn name(&self) -> &str

Get the tool’s name

fn description(&self) -> &str

Get the tool’s description

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

Optional JSON schema for the tool’s parameters, if available.

fn is_mutating(&self) -> bool

Whether this tool mutates state (files, environment, etc).

fn is_parallel_safe(&self) -> bool

Whether this tool is safe to run in parallel with other tools.

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

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

Execute with dual-channel output (LLM summary + UI content)

fn validate_args(&self, _args: &Value) -> Result<()>

Validate arguments before execution

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

Optional JSON schema for the tool’s configuration, if available.

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

Optional JSON schema describing state persisted by the tool, if any.

fn prompt_path(&self) -> Option<Cow<'static, str>>

Optional prompt path metadata (e.g., for loading companion prompts).

fn default_permission(&self) -> ToolPolicy

Default execution policy for this tool.

fn allow_patterns(&self) -> Option<&'static [&'static str]>

Optional allowlist patterns the tool considers pre-approved.

fn deny_patterns(&self) -> Option<&'static [&'static str]>

Optional denylist patterns the tool considers blocked.

fn kind(&self) -> &'static str

Get the kind/category of this tool for matching against policies.

fn matches_kind(&self, pattern: &str) -> bool

Check if this tool matches a given kind pattern.

fn resource_hints(&self, _args: &Value) -> Vec<String>

Resources this tool might access (paths, URLs, etc).

fn execution_cost(&self) -> u8

Estimated execution cost (1-10 scale).

fn resolve_and_validate_path<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, workspace_root: &'life1 Path, path: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<PathBuf>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Resolve a path relative to workspace root and validate it is within bounds