2025-12-01 11:38:48 -08:00
|
|
|
# Todo tool (`write_todos`)
|
2025-10-22 13:27:10 -07:00
|
|
|
|
2026-02-13 14:09:17 -08:00
|
|
|
The `write_todos` tool allows the Gemini agent to maintain an internal list of
|
|
|
|
|
subtasks for multi-step requests.
|
2025-10-22 13:27:10 -07:00
|
|
|
|
2026-02-13 14:09:17 -08:00
|
|
|
## Technical reference
|
2025-10-22 13:27:10 -07:00
|
|
|
|
2026-02-13 14:09:17 -08:00
|
|
|
The agent uses this tool to manage its execution plan and provide progress
|
|
|
|
|
updates to the CLI interface.
|
2025-10-22 13:27:10 -07:00
|
|
|
|
|
|
|
|
### Arguments
|
|
|
|
|
|
2026-02-13 14:09:17 -08:00
|
|
|
- `todos` (array of objects, required): The complete list of tasks. Each object
|
|
|
|
|
includes:
|
|
|
|
|
- `description` (string): Technical description of the task.
|
|
|
|
|
- `status` (enum): `pending`, `in_progress`, `completed`, or `cancelled`.
|
2025-10-22 13:27:10 -07:00
|
|
|
|
2026-02-13 14:09:17 -08:00
|
|
|
## Technical behavior
|
2025-10-22 13:27:10 -07:00
|
|
|
|
2026-02-13 14:09:17 -08:00
|
|
|
- **Interface:** Updates the progress indicator above the CLI input prompt.
|
|
|
|
|
- **Exclusivity:** Only one task can be marked `in_progress` at any time.
|
|
|
|
|
- **Persistence:** Todo state is scoped to the current session.
|
|
|
|
|
- **Interaction:** Users can toggle the full list view using **Ctrl+T**.
|
2025-10-22 13:27:10 -07:00
|
|
|
|
2026-02-13 14:09:17 -08:00
|
|
|
## Use cases
|
2025-10-22 13:27:10 -07:00
|
|
|
|
2026-02-13 14:09:17 -08:00
|
|
|
- Breaking down a complex feature implementation into manageable steps.
|
|
|
|
|
- Coordinating multi-file refactoring tasks.
|
|
|
|
|
- Providing visibility into the agent's current focus during long-running tasks.
|
2025-10-22 13:27:10 -07:00
|
|
|
|
2026-02-13 14:09:17 -08:00
|
|
|
## Next steps
|
2025-10-22 13:27:10 -07:00
|
|
|
|
2026-02-13 14:09:17 -08:00
|
|
|
- Follow the [Task planning tutorial](../cli/tutorials/task-planning.md) for
|
|
|
|
|
usage details.
|
|
|
|
|
- Learn about [Session management](../cli/session-management.md) for context.
|