PlanTool

Struct PlanTool 

Source
pub struct PlanTool { /* private fields */ }

Implementations§

Source§

impl PlanTool

Source

pub fn new(state: ToolState) -> Self

Trait Implementations§

Source§

impl SchemaTool for PlanTool

Source§

const NAME: &'static str = "Plan"

Source§

const DESCRIPTION: &'static str = r#"Manage structured planning workflow for complex implementation tasks. ## Actions - **start**: Begin plan mode for complex tasks (creates Draft plan) - **complete**: Finalize plan and proceed to implementation (approves plan) - **cancel**: Abort current plan - **update**: Update plan content while in plan mode - **status**: Check current plan state ## When to Use Plan Mode Use `action: "start"` for implementation tasks unless they're simple: 1. **New Feature Implementation**: Adding meaningful new functionality 2. **Multiple Valid Approaches**: Task can be solved in several ways 3. **Code Modifications**: Changes affecting existing behavior 4. **Architectural Decisions**: Choosing between patterns or technologies 5. **Multi-File Changes**: Task touching more than 2-3 files 6. **Unclear Requirements**: Need exploration before understanding scope ## When NOT to Use Skip for simple tasks: - Single-line fixes (typos, obvious bugs) - Adding a single function with clear requirements - Tasks with specific, detailed instructions - Pure research (use Task tool with Explore agent) ## Workflow 1. Call with `action: "start"` to enter plan mode 2. Explore codebase using Glob, Grep, Read tools 3. Call with `action: "update"` to record your plan 4. Call with `action: "complete"` to finalize and proceed ## Examples ```json // Start planning {"action": "start", "name": "Add user authentication"} // Update plan content {"action": "update", "content": "1. Add JWT middleware\n2. Create auth routes"} // Complete and proceed {"action": "complete"} // Check status {"action": "status"} // Cancel if needed {"action": "cancel"} ``` ## Integration - Use Plan for high-level approach and exploration - Use TodoWrite for granular task tracking during execution - Plan content persists across session compaction"#

Source§

type Input = PlanInput

Source§

fn handle<'life0, 'life1, 'async_trait>( &'life0 self, input: PlanInput, _context: &'life1 ExecutionContext, ) -> Pin<Box<dyn Future<Output = ToolResult> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

const STRICT: bool = false

Source§

fn input_schema() -> Value

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tool for T
where T: SchemaTool + 'static,

Source§

fn name(&self) -> &str

Source§

fn description(&self) -> &str

Source§

fn input_schema(&self) -> Value

Source§

fn definition(&self) -> ToolDefinition

Source§

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, input: Value, context: &'life1 ExecutionContext, ) -> Pin<Box<dyn Future<Output = ToolResult> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, T: 'async_trait,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more