Skip to main content

Planning Module

The planning module provides Planning Mode functionality similar to Cursor Plan Mode, Windsurf Planning Mode, Claude Code Plan Mode, and Gemini CLI Plan Mode.

Installation

Features

  • PlanningAgent - Creates implementation plans before execution
  • Plan and PlanStep - Dataclasses for plan structure
  • TodoList - Track progress through plan steps
  • PlanStorage - Persistence for plans
  • ApprovalCallback - Plan approval flow
  • Read-only mode - Safe research without modifications

Quick Start

Classes

Plan

Represents an implementation plan.

Attributes

PlanStep

A single step in a plan.

Attributes

TodoList

Track progress through plan steps.

Methods

TodoItem

A single todo item.

Attributes

PlanStorage

Persist plans to storage.

PlanningAgent

Agent that creates implementation plans.

ApprovalCallback

Callback for plan approval flow.

Tool Lists

READ_ONLY_TOOLS

Tools allowed in planning mode (safe for research):

RESTRICTED_TOOLS

Tools blocked in planning mode:

RESEARCH_TOOLS

Tools safe for planning research:

Usage Examples

Basic Planning Mode

Custom Planning LLM

Manual Plan Creation

Plan with Approval

Best Practices

  1. Use planning for complex tasks - Simple tasks don’t need planning
  2. Review plans before execution - Use approval callbacks
  3. Break down large plans - Keep steps manageable
  4. Track dependencies - Define step dependencies for proper ordering
  5. Persist plans - Save plans for review and resumption
  • Agent - Agent configuration
  • Task - Task definition
  • Agents - Multi-agent orchestration