@wrongstack/tools 0.1.9 → 0.2.0

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export { execTool } from './exec.js';
 export { fetchTool } from './fetch.js';
 export { searchTool } from './search.js';
 export { todoTool } from './todo.js';
+import { Tool } from '@wrongstack/core';
 export { gitTool } from './git.js';
 export { patchTool } from './patch.js';
 export { jsonTool } from './json.js';
@@ -31,4 +32,39 @@ export { toolHelpTool } from './tool-help.js';
 export { forgetTool, rememberTool } from './memory.js';
 export { createModeTool } from './mode.js';
 export { builtinTools } from './builtin.js';
-import '@wrongstack/core';
+
+/**
+ * `planTool` — the LLM-callable counterpart to the `/plan` slash command.
+ *
+ * Plans capture strategic, multi-step approaches that survive across
+ * session resumes (unlike todos, which are tactical and per-turn).
+ * Storage path comes from `ctx.meta['plan.path']` — the CLI seeds this
+ * during startup so the tool always knows where to read/write.
+ *
+ * One tool, multiple actions, JSON in/out. The action discriminates the
+ * operation so the LLM can do show / add / start / done / remove / clear
+ * via a single tool registration instead of bloating the surface with
+ * six near-identical tools.
+ */
+interface PlanInput {
+    action: 'show' | 'add' | 'start' | 'done' | 'remove' | 'clear';
+    /** Required for add. */
+    title?: string;
+    /** Optional detail line for add. */
+    details?: string;
+    /** Required for start/done/remove — accepts plan item id OR 1-based index OR title substring. */
+    target?: string;
+}
+interface PlanOutput {
+    ok: boolean;
+    message: string;
+    /** Formatted plan after the operation. Same string the user sees from `/plan show`. */
+    plan: string;
+    /** Total item count after the operation. */
+    count: number;
+    /** Number of items not in 'done' status. */
+    open: number;
+}
+declare const planTool: Tool<PlanInput, PlanOutput>;
+
+export { planTool };