@ian-pascoe/pi-todo 0.1.4 → 0.3.0

package/README.md

@@ -2,7 +2,7 @@
 
 `@ian-pascoe/pi-todo` gives Pi agents a minimal, session-native **Todo List** without imposing a planning workflow.
 
-Requires Node `>=22.19.0` and Pi `>=0.84.1`.
+Requires Node `>=22.19.0` and Pi `>=0.99.0`.
 
 ## Install
 
@@ -24,11 +24,22 @@ The `todo` tool supports five actions:
 | `remove` | `id`                                         | Removes one Task                  |
 | `clear`  | —                                            | Removes every Task and resets IDs |
 
+A Pi `codemode` script receives the result as an object (the tool declares an `outputSchema`) instead of the text (its field names are already single words, so they match Pi's snake_case convention); the model still reads the same text, and failures still throw:
+
+| Action           | Script value                                                                 |
+| ---------------- | ---------------------------------------------------------------------------- |
+| `list`           | `{ action: "list", tasks }`, each Task `{ id, title, description?, status }` |
+| `add` / `update` | `{ action, task }` with the resulting Task                                   |
+| `remove`         | `{ action: "remove", id }`                                                   |
+| `clear`          | `{ action: "clear", cleared }` with the number of Tasks removed              |
+
 Task status is `pending`, `active`, or `completed`; `add` defaults to `pending`. Tasks are flat, duplicate titles are allowed, and multiple Tasks may be active. Set `description` to `null` during `update` to remove it.
 
-Each changed Todo List is projected from its immutable session state entry as a hidden full snapshot at a fixed conversation position. Mutations inside a tool group appear after all sibling results; later requests keep earlier snapshots in place. Clearing the list produces an explicit empty snapshot. The system prompt and tool description do not change.
+Each tool group that changes the Todo List is projected from the immutable session state entries as one hidden full **Todo List Snapshot** of the group's final state, at a fixed conversation position after all of the group's sibling results. A tool group is one assistant turn's tool calls, including several `todo` calls inside one `codemode` script, so ten calls in a script add one Todo List Snapshot, not ten. A group that ends in the state it began with adds none. A change made outside a tool group, such as `/todo clear`, still projects its own Todo List Snapshot right away. Each Todo List Snapshot starts with the header `Todo List state from the pi-todo extension (not a user message):` so it does not read like user input. Later requests keep earlier Todo List Snapshots in place. Clearing the list produces an explicit empty Todo List Snapshot. The system prompt and tool description do not change.
+
+After compaction, a fixed baseline immediately after the summary restores the state from before the retained Tail. Retained and newer tool groups follow chronologically. This preserves previously written conversation cache prefixes between checkpoints; it does not guarantee provider cache hits.
 
-After compaction, a fixed baseline immediately after the summary restores the state from before the retained Tail. Retained and newer mutations follow chronologically. This preserves previously written conversation cache prefixes between checkpoints; it does not guarantee provider cache hits.
+`todo` declares MCP-style `annotations`: not read-only, but non-destructive (it only appends to the session's own journal), not idempotent, and closed-world. Pi reports them through `pi.getAllTools()` for permission extensions and does not send them to model providers.
 
 ## UI and persistence
 
@@ -38,6 +49,6 @@ State is stored only in `pi-todo-state` session entries, without a second messag
 
 A failed journal write leaves acknowledged Todo state unchanged and disables Todo in that loaded session, including across `/reload`. Pi has an existing persistence limitation: subsequent entries can reference the unwritten entry, so reopening may omit earlier history from the selected branch even though it remains in the file. Todo does not repair session history; recovery is outside this cache-prefix change.
 
-Missing or ambiguous conversation anchors abort the request instead of silently relocating snapshots. Extensions that rewrite those anchors are unsupported.
+Missing or ambiguous conversation anchors abort the request instead of silently relocating Todo List Snapshots. Extensions that rewrite those anchors are unsupported.
 
 This is privileged extension code: review it before installing it into an agent that can access local files, tools, or credentials.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ian-pascoe/pi-todo",
-  "version": "0.1.4",
+  "version": "0.3.0",
   "private": false,
   "description": "Minimal session-native Todo List for Pi agents.",
   "keywords": [
@@ -33,9 +33,9 @@
     "provenance": true
   },
   "peerDependencies": {
-    "@earendil-works/pi-ai": "*",
-    "@earendil-works/pi-coding-agent": "*",
-    "@earendil-works/pi-tui": "*",
+    "@earendil-works/pi-ai": ">=0.99.0",
+    "@earendil-works/pi-coding-agent": ">=0.99.0",
+    "@earendil-works/pi-tui": ">=0.99.0",
     "typebox": "*"
   },
   "engines": {
@@ -50,7 +50,7 @@
     ]
   },
   "scripts": {
-    "test": "vitest run --config ../../vitest.config.ts --root .",
+    "test": "vitest run",
     "typecheck": "tsc --noEmit -p tsconfig.json"
   }
 }

package/src/pi-todo-extension.ts

@@ -8,6 +8,7 @@ import {
   createEmptyTodoState,
   TODO_ACTIONS,
   TODO_STATUSES,
+  TodoToolOutputSchema,
   todoStatusMarker,
   type TodoActionInput,
   type TodoStateSnapshot,
@@ -160,6 +161,13 @@ export default function piTodoExtension(pi: ExtensionAPI): void {
     label: "Todo",
     description: "Manage the current session branch's Todo List.",
     parameters: TodoParameters,
+    annotations: {
+      readOnlyHint: false,
+      destructiveHint: false,
+      idempotentHint: false,
+      openWorldHint: false,
+    },
+    outputSchema: TodoToolOutputSchema,
     executionMode: "sequential",
     async execute(_toolCallId, params, signal, _onUpdate, context) {
       signal?.throwIfAborted();
@@ -175,6 +183,9 @@ export default function piTodoExtension(pi: ExtensionAPI): void {
       return {
         content: [{ type: "text", text: result.message }],
         details: result.details,
+        // Separate from `details` so the session's render shape and the script-facing value can
+        // evolve independently; today both use the same snake_case-compatible field names.
+        structuredContent: structuredClone(result.details),
       };
     },
     renderCall: (params, theme) => {

package/src/todo-context.ts

@@ -14,6 +14,8 @@ import {
 } from "./todo-list.js";
 
 type Message = ContextEvent["messages"][number];
+/** Marks a snapshot as extension state so the model does not read it as user-authored. */
+const SNAPSHOT_HEADER = "Todo List state from the pi-todo extension (not a user message):";
 const ProjectionDetails = Type.Object(
   {
     version: Type.Literal(1),
@@ -50,7 +52,7 @@ function snapshotMessage(
     role: "custom",
     customType: "pi-todo-context",
     display: false,
-    content: `Todo List:\n${formatTodoList(state.tasks)}`,
+    content: `${SNAPSHOT_HEADER}\n${formatTodoList(state.tasks)}`,
     timestamp: Date.parse(entry.timestamp),
     details: { version: 1, stateEntryId: entry.id, checkpointId },
   };
@@ -110,27 +112,26 @@ export function projectTodoContext(
     }
   }
   const outstanding = new Map<string, number>();
-  let pending: Message[] = [];
+  // A tool group projects only its final state, once its last result has landed.
+  let pending: { entry: SessionEntry; state: TodoStateSnapshot } | undefined;
+  const project = (entry: SessionEntry, state: TodoStateSnapshot): void => {
+    const content = formatTodoList(state.tasks);
+    if (content !== previousContent && (previousContent !== undefined || state.tasks.length > 0))
+      insert(snapshotMessage(entry, state, null));
+    previousContent = content;
+  };
   for (const entry of branch.slice(start)) {
     if (entry === checkpoint) continue;
     const state = todoStateFromEntry(entry);
     if (state) {
-      const content = formatTodoList(state.tasks);
-      if (
-        content !== previousContent &&
-        (previousContent !== undefined || state.tasks.length > 0)
-      ) {
-        const snapshot = snapshotMessage(entry, state, null);
-        if (outstanding.size > 0) pending.push(snapshot);
-        else insert(snapshot);
-      }
-      previousContent = content;
+      if (outstanding.size > 0) pending = { entry, state };
+      else project(entry, state);
       continue;
     }
     const message = conversationMessage(entry);
     if (!message) continue;
     if (message.role === "assistant") {
-      if (outstanding.size > 0 && pending.length > 0)
+      if (outstanding.size > 0 && pending)
         throw new Error("Todo mutation has an incomplete tool group");
       outstanding.clear();
       for (const block of message.content)
@@ -142,12 +143,12 @@ export function projectTodoContext(
       else outstanding.delete(message.toolCallId);
     }
     anchor = message;
-    if (outstanding.size === 0 && pending.length > 0) {
-      for (const snapshot of pending) insert(snapshot);
-      pending = [];
+    if (outstanding.size === 0 && pending) {
+      project(pending.entry, pending.state);
+      pending = undefined;
     }
   }
-  if (pending.length > 0) throw new Error("Todo mutation has an incomplete tool group");
+  if (pending) throw new Error("Todo mutation has an incomplete tool group");
   return [
     ...(insertions.get(-1) ?? []),
     ...messages.flatMap((message, index) => [message, ...(insertions.get(index) ?? [])]),

package/src/todo-list.ts

@@ -41,10 +41,15 @@ export type TodoActionInput = {
   readonly status?: TodoStatus;
 };
 
-/** Render details whose action discriminates list data from mutation acknowledgements. */
+/**
+ * Render details and the tool's structured result. The action discriminates the list from the
+ * Task a mutation added or updated, the ID it removed, and the count it cleared.
+ */
 export type TodoToolDetails =
   | { readonly action: "list"; readonly tasks: readonly TodoTask[] }
-  | { readonly action: Exclude<TodoAction, "list"> };
+  | { readonly action: "add" | "update"; readonly task: TodoTask }
+  | { readonly action: "remove"; readonly id: TodoTaskId }
+  | { readonly action: "clear"; readonly cleared: number };
 
 const PositiveSafeIntegerRecord = Type.Integer({
   minimum: 1,
@@ -57,6 +62,32 @@ const TodoTaskRecord = Type.Object({
   status: StringEnum(TODO_STATUSES),
 });
 
+/**
+ * JSON Schema of the `todo` tool's `structuredContent`, which codemode scripts receive instead of
+ * the model-facing text. Flat so Pi's one-line script declaration stays compact; `action` says
+ * which other field is present.
+ */
+export const TodoToolOutputSchema = Type.Object(
+  {
+    action: StringEnum(TODO_ACTIONS, { description: "The operation that ran" }),
+    tasks: Type.Optional(
+      Type.Array(TodoTaskRecord, { description: "list: every Task in ID order" }),
+    ),
+    task: Type.Optional(TodoTaskRecord),
+    id: Type.Optional(
+      Type.Integer({
+        minimum: 1,
+        maximum: Number.MAX_SAFE_INTEGER,
+        description: "remove: ID of the removed Task",
+      }),
+    ),
+    cleared: Type.Optional(
+      Type.Integer({ minimum: 0, description: "clear: number of Tasks removed" }),
+    ),
+  },
+  { additionalProperties: false },
+);
+
 /** Serialized shape stored in a `pi-todo-state` session entry. */
 export const TodoStateRecord = Type.Object({
   nextId: PositiveSafeIntegerRecord,
@@ -158,7 +189,7 @@ export function applyTodoAction(
         ok: true,
         state: { nextId: state.nextId + 1, tasks: [...state.tasks, task] },
         message: `Added Task #${task.id}`,
-        details: { action: "add" },
+        details: { action: "add", task },
       };
     }
 
@@ -190,7 +221,7 @@ export function applyTodoAction(
             tasks: state.tasks.filter((candidate) => candidate.id !== task.id),
           },
           message: `Removed Task #${task.id}`,
-          details: { action: "remove" },
+          details: { action: "remove", id: task.id },
         };
       }
       if (
@@ -224,7 +255,7 @@ export function applyTodoAction(
           ),
         },
         message: `Updated Task #${task.id}`,
-        details: { action: "update" },
+        details: { action: "update", task: updatedTask },
       };
     }
 
@@ -234,7 +265,7 @@ export function applyTodoAction(
         ok: true,
         state: count > 0 || state.nextId !== 1 ? createEmptyTodoState() : state,
         message: `Cleared ${count} ${count === 1 ? "Task" : "Tasks"}`,
-        details: { action: "clear" },
+        details: { action: "clear", cleared: count },
       };
     }
   }