Struct UpdatePlanTool 

pub struct UpdatePlanTool;

A simple plan / task tracker. The model calls it to record or update a checklist of steps (the analog of Codex update_plan / Claude’s plan mode).

BP-8 (catalog:156 “Todos/plan persisted per session”): the plan itself lives on ToolContext::plan, not in this tool. A tool-local mutex was unreadable by the agent, so [capabilities.todos] persist = true had nothing to persist and a plan died with the process; on the shared context, the agent journals every change and a resume restores it.

Trait Implementations

impl Default for UpdatePlanTool

fn default() -> UpdatePlanTool

Returns the “default value” for a type.

impl Tool for UpdatePlanTool

fn name(&self) -> &str

Stable, unique tool name (what the model calls).

fn description(&self) -> &str

The built-in description. May be overridden via crate::Config.

fn parameters(&self) -> Value

JSON Schema describing the tool’s input object.

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

where 'life0: 'async_trait, 'life1: 'async_trait, UpdatePlanTool: 'async_trait,

Run the tool. Returns text to feed back to the model.

fn structured_output(&self) -> bool

Whether a successful textual result is also a complete JSON value that protocol adapters should expose as structured output. Text remains the model-facing representation, preserving compatibility.