Quick Start
How It Works
| Phase | What happens |
|---|---|
| 1. Research | The agent gathers context and drafts a step-by-step plan |
| 2. Review | With auto_approve=False, the plan is shown for your approval before any action |
| 3. Execute | Once approved (or auto-approved), the agent runs the plan step by step |
Choosing Your Planning Mode
Configuration Options
Full list of
PlanningConfig options, types, and defaults.All PlanningConfig fields
All PlanningConfig fields
| Field | Type | Default | What it does |
|---|---|---|---|
llm | str | None | None | Planning LLM when different from the agent’s main LLM |
tools | list | None | None | Tools available during the planning phase |
reasoning | bool | False | Enable reasoning while drafting the plan |
auto_approve | bool | False | Run the plan without asking for your approval |
read_only | bool | False | Restrict planning to read-only operations |
Common Patterns
Pattern 1 — Auto-approve a safe task
For low-risk, repeatable tasks, skip the review step and run the plan straight through.Pattern 2 — Read-only research mode
Restrict the agent to reads during planning so it can investigate without side effects.Pattern 3 — Separate planning LLM with tools
Use a cheaper model to draft the plan and give the planning phase its own tools.Best Practices
Start with planning=True
Start with planning=True
Turn planning on with the default config before reaching for
PlanningConfig. The default already separates drafting from execution, so you see the plan before it runs. Add config only when you need a different LLM or approval behavior.Keep auto_approve=False for irreversible actions
Keep auto_approve=False for irreversible actions
Anything that writes files, sends messages, or makes API calls is hard to undo. Leave
auto_approve=False for those tasks so the plan lands in front of you before any change happens. Reserve auto_approve=True for read-heavy or idempotent work.Use a cheaper planning LLM
Use a cheaper planning LLM
Drafting a plan is lighter work than executing it. Set
llm to a cheaper model (for example gpt-4o-mini) for the planning phase, and keep your stronger model on the agent for execution.Reach for read_only on investigations
Reach for read_only on investigations
When you only need answers — not changes — set
read_only=True. The agent can explore and report without the risk of writing or calling mutating tools during planning.Related
Planning Mode — the review and approval workflow in depth.
PlanningConfig — full options, types, and defaults.

