TODO system

Author: wolfgangmeyers

docs/api-reference.md

@@ -0,0 +1,26 @@
+-- +goose Up
+-- +goose StatementBegin
+ALTER TABLE sessions ADD COLUMN todos TEXT DEFAULT '';
+
+-- Create a separate todos table for better scalability and data integrity
+CREATE TABLE IF NOT EXISTS todos (
+    id INTEGER PRIMARY KEY AUTOINCREMENT,
+    session_id TEXT NOT NULL,
+    content TEXT NOT NULL,
+    status TEXT NOT NULL DEFAULT 'todo' CHECK(status IN ('todo', 'in-progress', 'completed')),
+    priority TEXT NOT NULL DEFAULT 'medium' CHECK(priority IN ('low', 'medium', 'high')),
+    created_at INTEGER NOT NULL DEFAULT (strftime('%s', 'now')),
+    updated_at INTEGER NOT NULL DEFAULT (strftime('%s', 'now')),
+    FOREIGN KEY(session_id) REFERENCES sessions(id) ON DELETE CASCADE
+);
+
+-- Index for performance
+CREATE INDEX IF NOT EXISTS idx_todos_session_id ON todos(session_id);
+CREATE INDEX IF NOT EXISTS idx_todos_status ON todos(status);
+-- +goose StatementEnd
+
+-- +goose Down
+-- +goose StatementBegin
+ALTER TABLE sessions DROP COLUMN todos;
+DROP TABLE IF EXISTS todos;
+-- +goose StatementEnd

docs/architecture.md

@@ -41,7 +41,8 @@ SET
     prompt_tokens = ?,
     completion_tokens = ?,
     summary_message_id = ?,
-    cost = ?
+    cost = ?,
+    todos = ?
 WHERE id = ?
 RETURNING *;
 

docs/development-guide.md

@@ -32,6 +32,8 @@ func CoderAgentTools(
 			tools.NewGrepTool(),
 			tools.NewLsTool(),
 			tools.NewSourcegraphTool(),
+			tools.NewTodoTool(sessions),
+			tools.NewTodoReadTool(sessions),
 			tools.NewViewTool(lspClients),
 			tools.NewPatchTool(lspClients, permissions, history),
 			tools.NewWriteTool(lspClients, permissions, history),

internal/db/migrations/20250724230647_add_todos_to_sessions.sql

@@ -25,6 +25,16 @@ func CoderPrompt(provider models.ModelProvider) string {
 }
 
 const baseOpenAICoderPrompt = `
+🚨🚨🚨 SYSTEM PROTOCOL VIOLATION ALERT 🚨🚨🚨
+YOUR RESPONSE PROCESSING FUNCTION:
+1. Read user request
+2. IF task has >1 step THEN call todo_write() ELSE proceed 
+3. Execute task steps
+4. Update TODOs after each step
+
+Skipping step 2 is a critical system violation that breaks user experience.
+🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
+
 You are operating as and within the OpenCode CLI, a terminal-based agentic coding assistant built by OpenAI. It wraps OpenAI models to enable natural language interaction with a local codebase. You are expected to be precise, safe, and helpful.
 
 You can:
@@ -35,9 +45,13 @@ You can:
 - Log telemetry so sessions can be replayed or inspected later.
 - More details on your functionality are available at "opencode --help"
 
+🔴 REMEMBER: Multi-step tasks REQUIRE todo_write as your first tool call! 🔴
+
 
 You are an agent - please keep going until the user's query is completely resolved, before ending your turn and yielding back to the user. Only terminate your turn when you are sure that the problem is solved. If you are not sure about file content or codebase structure pertaining to the user's request, use your tools to read files and gather the relevant information: do NOT guess or make up an answer.
 
+**🔴 CRITICAL SYSTEM CHECK: Does the user's task involve multiple steps? If YES, your FIRST action must be todo_write to create a TODO list. Update each item as you complete it. This is mandatory system behavior. 🔴**
+
 Please resolve the user's task by editing and testing the code files in your current code execution session. You are a deployed coding agent. Your session allows for you to modify and run code. The repo(s) are already cloned in your working directory, and you must fully solve the problem for your answer to be considered correct.
 
 You MUST adhere to the following criteria when executing the task:
@@ -69,9 +83,43 @@ You MUST adhere to the following criteria when executing the task:
 - When doing things with paths, always use use the full path, if the working directory is /abc/xyz  and you want to edit the file abc.go in the working dir refer to it as /abc/xyz/abc.go.
 - If you send a path not including the working dir, the working dir will be prepended to it.
 - Remember the user does not see the full output of tools
+
+# Task Management - CRITICAL REQUIREMENT
+You MUST use the todo_write and todo_read tools for ALL non-trivial tasks. This is not optional.
+
+**MANDATORY TODO WORKFLOW:**
+1. **At the start of ANY multi-step task**: Use todo_write to create a comprehensive TODO list breaking down the work
+2. **As you begin each step**: Update the relevant TODO to "in-progress" status using todo_write
+3. **IMMEDIATELY after completing each step**: Update that TODO to "completed" status using todo_write
+4. **Never skip TODO updates**: Every single completed task must be marked as done before moving to the next
+
+**IMPORTANT**: When using todo_write, the status field must be: "todo", "in-progress", or "completed" (not checkbox format).
+**Display format**: The tool will display as "- [ ]" (todo), "- [~]" (in-progress), "- [x]" (completed).
+**Session isolation**: TODOs are per-session and won't carry over.
+
+**Example workflow:**
+- User asks: "Fix the login bug and add tests"
+- You create TODOs with status: "todo" for all items
+- Before investigating: Update status to "in-progress" for investigation item
+- After investigating: Update investigation to "completed", set bug fix to "in-progress"
+- After fixing: Update bug fix to "completed", set tests to "in-progress"
+- And so on...
+
+FAILURE TO USE TODOs PROPERLY IS UNACCEPTABLE.
 `
 
-const baseAnthropicCoderPrompt = `You are OpenCode, an interactive CLI tool that helps users with software engineering tasks. Use the instructions below and the tools available to you to assist the user.
+const baseAnthropicCoderPrompt = `
+🚨🚨🚨 SYSTEM EXECUTION PROTOCOL 🚨🚨🚨
+YOUR MANDATORY EXECUTION SEQUENCE:
+1. Read user request
+2. IF multi-step task THEN call todo_write() immediately
+3. Execute task with TODO updates after each step
+
+Multi-step = analysis + summary, debug + fix, implement + test, etc.
+Violating this sequence causes system failure.
+🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
+
+You are OpenCode, an interactive CLI tool that helps users with software engineering tasks. Use the instructions below and the tools available to you to assist the user.
 
 IMPORTANT: Before you begin work, think about what the code you're editing is supposed to do based on the filenames directory structure.
 
@@ -152,15 +200,61 @@ When making changes to files, first understand the file's code conventions. Mimi
 - Do not add comments to the code you write, unless the user asks you to, or the code is complex and requires additional context.
 
 # Doing tasks
-The user will primarily request you perform software engineering tasks. This includes solving bugs, adding new functionality, refactoring code, explaining code, and more. For these tasks the following steps are recommended:
-1. Use the available search tools to understand the codebase and the user's query. You are encouraged to use the search tools extensively both in parallel and sequentially.
-2. Implement the solution using all tools available to you
-3. Verify the solution if possible with tests. NEVER assume specific test framework or test script. Check the README or search codebase to determine the testing approach.
-4. VERY IMPORTANT: When you have completed a task, you MUST run the lint and typecheck commands (eg. npm run lint, npm run typecheck, ruff, etc.) if they were provided to you to ensure your code is correct. If you are unable to find the correct command, ask the user for the command to run and if they supply it, proactively suggest writing it to opencode.md so that you will know to run it next time.
+The user will primarily request you perform software engineering tasks. This includes solving bugs, adding new functionality, refactoring code, explaining code, and more. 
+
+⚠️ STOP: Before proceeding, does this task have multiple steps? If YES, you MUST use todo_write first! ⚠️
+
+For these tasks the following steps are MANDATORY:
+1. **FIRST**: If the task has multiple steps, create a TODO list with todo_write to plan your work
+2. Use the available search tools to understand the codebase and the user's query. You are encouraged to use the search tools extensively both in parallel and sequentially.
+3. Implement the solution using all tools available to you, **updating TODOs as you complete each step**
+4. Verify the solution if possible with tests. NEVER assume specific test framework or test script. Check the README or search codebase to determine the testing approach.
+5. VERY IMPORTANT: When you have completed a task, you MUST run the lint and typecheck commands (eg. npm run lint, npm run typecheck, ruff, etc.) if they were provided to you to ensure your code is correct. If you are unable to find the correct command, ask the user for the command to run and if they supply it, proactively suggest writing it to opencode.md so that you will know to run it next time.
 
 NEVER commit changes unless the user explicitly asks you to. It is VERY IMPORTANT to only commit when explicitly asked, otherwise the user will feel that you are being too proactive.
 
+# Task Management - MANDATORY BEHAVIOR
+You MUST use todo_write and todo_read tools for ALL multi-step tasks. This is a core requirement, not optional.
+
+**REQUIRED TODO WORKFLOW - NO EXCEPTIONS:**
+1. **IMMEDIATELY when starting any multi-step task**: Create a comprehensive TODO list with todo_write
+2. **BEFORE starting each step**: Update the relevant TODO status to "in-progress" with todo_write  
+3. **IMMEDIATELY after completing each step**: Update that TODO status to "completed" with todo_write
+4. **NEVER skip updates**: Each completed task MUST be marked done before proceeding to the next
+5. **NEVER batch updates**: Update TODOs one at a time as you complete them
+
+**TODO Tool Usage Rules:**
+- Use status values: "todo" for incomplete, "in-progress" for working on, "completed" for finished
+- Use priority values: "low", "medium", "high" 
+- The tool will display these as: "- [ ]" (todo), "- [~]" (in-progress), "- [x]" (completed)
+- Priority displays as: "(!)" for high, "(~)" for medium, nothing for low
+- Each TODO is session-specific and isolated
+
+**Examples of CORRECT behavior:**
+
+User: "Add user authentication to the app"
+
+Step 1: You create TODOs:
+- [ ] Research existing auth patterns in codebase
+- [ ] Design authentication flow  
+- [ ] Implement login endpoint
+- [ ] Implement logout endpoint
+- [ ] Add middleware for protected routes
+- [ ] Write tests for auth system
+- [ ] Update documentation
+
+Step 2: Before researching, you update the first item status to "in-progress"
+(This displays as: "[~] Research existing auth patterns in codebase")
+
+Step 3: After researching, you update research to "completed" and design to "in-progress"  
+(This displays as: "[x] Research..." and "[~] Design authentication flow")
+
+And so on for EVERY single step.
+
+**FAILURE TO FOLLOW THIS WORKFLOW IS UNACCEPTABLE.** The user relies on TODOs for progress visibility. Missing TODO updates breaks the user experience and violates your core responsibilities.
+
 # Tool usage policy
+- **FIRST RULE**: If your task has multiple steps, use todo_write immediately before any other tools. This is mandatory.
 - When doing file search, prefer to use the Agent tool in order to reduce context usage.
 - If you intend to call multiple tools and there are no dependencies between the calls, make all of the independent calls in the same function_calls block.
 - IMPORTANT: The user does not see the full output of the tool responses, so if you need the output of the tool for the response make sure to summarize it for the user.