Docs

Built-in tools›Plan mode

Plan document

plan
Group
Plan mode
Turned on by
Plan mode (the Plan switch under the composer).
Approval
Not reviewed: runs without asking, within the limits on this page.
Profile key
tool.plan.description

Writes or reads the conversation's plan, the Markdown document you review in plan mode before the model changes your repository.

While the Plan switch under the composer is on, the model researches, writes its plan with this tool, then asks you to approve it with exit_plan_mode. Read the plan from the Implementation plan row in the Tasks pane (More options → Tasks). See Plan mode.

Good to know

  • The plan is stored with the conversation, not as a file in your workspace. Each write replaces the whole plan.
  • Rewriting a plan you approved or sent feedback on makes it a new draft.
  • The tool arrives the first time you turn Plan on and stays for the rest of the conversation, so the model can reread the approved plan while it implements it.

Parameters

ParameterTypeDetails
action required
Action
stringwrite stores or replaces this conversation's plan document with content; read returns the document currently stored.
"write" "read"
content
File content
stringRequired for write. The plan's Markdown body: context, the recommended approach, the critical files, the utilities to reuse, and how the work will be verified. The whole document is replaced, so send the complete plan every time.

Edit this page on GitHub