@andares/pi-toolkits 0.9.5 → 0.9.7

package/README.md

@@ -7,6 +7,7 @@
 > Integrated toolkit extension for [pi](https://github.com/earendil-works/pi-coding-agent) — one package, growing new capabilities over time.
 
 [![npm version](https://img.shields.io/npm/v/@andares/pi-toolkits?label=npm&logo=npm)](https://www.npmjs.com/package/@andares/pi-toolkits)
+[![Pi package gallery](https://img.shields.io/badge/pi.dev-package%20gallery-6f42c1)](https://pi.dev/packages/@andares/pi-toolkits)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 [![Package Manager](https://img.shields.io/badge/package%20manager-pnpm-orange?logo=pnpm)](https://pnpm.io)
 [![pi >= 1.0](https://img.shields.io/badge/pi-%3E%3D1.0.0%20%3C1.12.0-blueviolet)](https://github.com/earendil-works/pi)
@@ -14,7 +15,7 @@
 
 In a nutshell: seven ready-to-use capabilities — **read-only consult mode** `ask`, **session-scoped boundary permission** `ask-perm`, **model favorites** `favorites`, **prompt stash** `stash`, **third-party code review** `third-review`, **dedicated compaction model** `compact-model` and **session startup automation** `autostart` — with more to come.
 
-**Requirements**: pi `>=1.0.0 <1.12.0` — the four most recently released minor lines (1.0.x / 1.1.x / 1.2.x / 1.3.x) are supported best-effort, and the upper bound encodes the forward probe: on every host release we check up to **8 minor lines** beyond the newest one (now 1.4 … 1.11) and never claim past that cap. **Measured natural compatibility: 1.3.0** (the newest release at the time of writing — nothing newer exists to probe yet). A single command, `pnpm check:compat`, derives that version set from the registry and runs, per version, in a sandbox under the system temp dir with the whole `@earendil-works/*` family pinned to the version under test: install → `tsc --noEmit` → full test suite → keybinding audit → hash-compare of the host `dist` files this package patches or mirrors. Results over 1.0.0 → 1.3.0 (all 8 published versions): typecheck, 397 tests and the keybinding audit pass on every one; the tracked host files drift only in `core/agent-session.js` (1.3.0 changed the tool-restore path; `cycleModel` untouched), `core/keybindings.js` and `core/compaction/utils.js` (both changed in 1.2.0, table semantics for our keys unchanged), and `extensions/types.d.ts` (additive) — `ModelSelectorComponent`, `core/compaction/compaction.js` and `core/usage-totals.js` are byte-identical across the whole window. Smoke-loading on real pi 1.3.0 produces no warnings. Note: pi ≥ 0.99 hosts require `@earendil-works/pi-tui` to be declared in `peerDependencies` as `"*"` (provided by the host); this package declares it as required.
+**Requirements**: pi `>=1.0.0 <1.12.0` — the four most recently released minor lines (1.0.x / 1.1.x / 1.2.x / 1.3.x) are supported best-effort, and the upper bound encodes the forward probe: on every host release we check up to **8 minor lines** beyond the newest one (now 1.4 … 1.11) and never claim past that cap. **Measured natural compatibility: 1.3.0** (the newest release at the time of writing — nothing newer exists to probe yet). A single command, `pnpm check:compat`, derives that version set from the registry and runs, per version, in a sandbox under the system temp dir with the whole `@earendil-works/*` family pinned to the version under test: install → `tsc --noEmit` → full test suite → keybinding audit → hash-compare of the host `dist` files this package patches or mirrors. Results over 1.0.0 → 1.3.0 (all 8 published versions): typecheck, 473 tests and the keybinding audit pass on every one; the tracked host files drift only in `core/agent-session.js` (1.3.0 changed the tool-restore path; `cycleModel` untouched), `core/keybindings.js` and `core/compaction/utils.js` (both changed in 1.2.0, table semantics for our keys unchanged), and `extensions/types.d.ts` (additive) — `ModelSelectorComponent`, `core/compaction/compaction.js` and `core/usage-totals.js` are byte-identical across the whole window. Smoke-loading on real pi 1.3.0 produces no warnings. Note: pi ≥ 0.99 hosts require host-provided packages to be declared in `peerDependencies` with a `"*"` range — `@earendil-works/pi-tui` and `typebox` (the `scratchpad` tool builds a TypeBox schema) are declared that way; an installed copy in `dependencies` would make pi warn.
 
 ---
 
@@ -23,7 +24,8 @@ In a nutshell: seven ready-to-use capabilities — **read-only consult mode** `a
 <a name="install"></a>
 
 ```bash
-# from npm (recommended)
+# from npm (recommended) — also indexed in the official pi package gallery
+# https://pi.dev/packages/@andares/pi-toolkits
 pi install npm:@andares/pi-toolkits
 
 # local development install
@@ -35,7 +37,7 @@ pi -e ./src/index.ts
 
 After installing, verify in any pi session:
 
-- `/ask` → a grey `ask` status appears in the footer, `write`/`edit` are hard-disabled
+- `/ask` → a grey `ask` status appears in the footer, `write`/`edit` are hard-disabled, and a `scratchpad` tool appears for throwaway notes
 - `/model` (or `ctrl+l`) → a favorites hint line appears at the top of the selector; `ctrl+A` on the selected model → it turns bold bright yellow and the favorites counter goes up (this step is also the real-machine keypress check — see Keybindings)
 - press `ctrl+alt+y` in the input box → the current prompt is stashed and the input box is cleared
 - after finishing a development task, type `/third-review` → switches to the review model and runs check + fix
@@ -66,7 +68,7 @@ After installing, verify in any pi session:
 
 | Feature | Entry point | One-line description |
 | --- | --- | --- |
-| 🛡️ **ask** read-only consult mode | `/ask` | enter read-only Q&A mode: `write`/`edit`/`powershell` hard-disabled, `bash` runs in a read-only sandbox, `grep`/`find`/`ls` activated |
+| 🛡️ **ask** read-only consult mode | `/ask` | enter consult mode: `write`/`edit`/`powershell` hard-disabled, `bash` runs in a read-only sandbox, `grep`/`find`/`ls` activated, and `scratchpad` allowed to write throwaway notes into the session's temp directory |
 | 🔐 **permission** session-scoped boundary checks | `/ask-perm` | four in/out × read/write modes, off by default and never persisted; outside writes ask, credentials are denied, destructive commands always ask; composes with `/ask` |
 | ⭐ **favorites** model favorites | `ctrl+A` / `ctrl+J` inside `/model` | favorite the models you use most (marked in bold bright yellow), `ctrl+p` cycles only among favorites |
 | 📥 **stash** prompt stash | `ctrl+alt+y` | a stash slot for one prompt: press to swap, press twice to stash and clear the input box |
@@ -80,17 +82,21 @@ After installing, verify in any pi session:
 
 <a name="ask"></a>
 
-Enter with `/ask` (press it again to exit). Meant for the case where you only want to "ask questions and read code", and absolutely never want the model to modify any file.
+Enter with `/ask` (press it again to exit). Meant for the case where you only want to "ask questions and read code": the model may not change the project, but it is not starved of a place to think.
 
 **While active**:
 
-- **`write` / `edit` / `powershell` hard-disabled** — removed from the active tool set; pi rejects calls to inactive tools outright ("Tool not found"), so file modification becomes mechanically impossible
+- **Project writes stay mechanically impossible** — `write` / `edit` / `powershell` are removed from the active tool set, so pi rejects calls to inactive tools outright ("Tool not found"); the gate blocks them again as defence in depth
+- **One write channel: `scratchpad`** — a tool that takes a *relative* note name (`plan.md`, `notes/api.md`) and can only reach `<os.tmpdir()>/pi-ask/<session-id>`. It is registered inactive (`defaultActive: false`) and activated only in ask mode, so its declaration and its "notes are not deliverables" guidelines are part of the request exactly when they apply. Notes are capped at 256 KiB each, a pre-existing symlinked path component is refused, and nothing written there is ever executed — the bash sandbox needs no write allowance at all. On a host with no writable temp dir the tool stays inactive and the mode degrades to the old fully read-only behaviour (the entry notice says so instead of half-opening the mode)
 - **Read-only helper tools activated** — `grep` / `find` / `ls` (registered by pi but inactive by default) are switched on for the duration, so the model gets proper search tools instead of bash-only search; the entry snapshot is restored exactly on exit
 - **`bash` kept, but sandboxed to read-only** — shell tokenization, per-segment validation plus write-intent detection. Allowed beyond the obvious readers: git archaeology (`blame`, `grep`, `rev-parse`, `describe`, `shortlog`, `reflog show`, `stash list`, `tag -l`, `cat-file`, ...), package metadata queries (`pnpm view`, `pip show/list`, `python -m json.tool`) and network reads through `curl -s <url>` / `wget -O - <url>`. Still blocked: redirections, `tee`, `dd`, `sed -i`, installs/builds, git mutations, command substitution, command runners (`find -exec`, `git grep -O`, `rg --pre`), and every write target (`curl -o`, `wget -O file`, `git diff --output=`, `tree -o`). Heuristic, not a security boundary
-- **System prompt appendix names the alternatives** — the appended mode description states what is blocked *and what to use instead* (`read` for file contents, `curl -s` for URLs, `/ask` to exit). Rejected tool calls come back with a classified reason that points at the nearest allowed alternative, so the model does not retry blind variants
-- **Grey `ask` footer status** — a permanent reminder that read-only mode is on
+- **A short system-prompt banner** — three lines: consult only, the scratch channel, the exit path. The bash allowlist is deliberately *not* restated there: the sandbox enforces it and a rejection names the allowed alternative, so that detail costs tokens only on the turn it is needed (the old banner restated it on every request, ~300 tokens). The banner carries no path and no timestamp, so it stays byte-identical for the session and remains a cacheable prefix
+- **Rejections point at the next step** — a blocked `write` / `edit` names `scratchpad` for throwaway notes and `/ask` for a real change; a blocked redirect says the same instead of only "cannot write"
+- **Grey `ask` footer status** — a permanent reminder that consult mode is on
 
-**Exit**: press `/ask` again; the tool-set snapshot taken on entry is fully restored (read-only helpers included).
+**Scratch lifecycle**: one directory per session under the OS temp dir (`os.tmpdir()`, so Windows `%TEMP%` works too), created on entry and kept on exit — a resumed session finds its notes again, and an in-process session switch (/new, /resume, fork) rebinds the directory to the new session id. Directories older than seven days are removed when a session enters ask mode. The ON notice prints the path; nothing in it is part of the project and it never shows up in `git status`.
+
+**Exit**: press `/ask` again; the tool-set snapshot taken on entry is fully restored (scratch tool and read-only helpers included).
 
 ---
 
@@ -131,7 +137,7 @@ Repeating the argument form with the modes already in force is a **no-op**: no s
 - **credentials are denied in every mode** — `~/.ssh`, `~/.gnupg`, `~/.aws`, `~/.pi/agent/auth*.json`, `.env` files (templates excepted). Without this, `out read = allow` would hand out `~/.ssh/id_rsa`.
 - **destructive commands always ask** — `rm` of `/`, the home directory, or the working directory; `git reset --hard`; `git clean -f`; `git push --force`; package `publish`; `dd` to a raw device; `mkfs*`; shutdown/reboot; `chmod -R 777`; anything through `sudo`. Scope alone cannot express "destructive".
 
-**Composition with `/ask`**: the two features are independent gates on one bus. Each answers only its own question — ask: "does this mutate?", permission: "does this cross the boundary?" — and either can block. Ask mode still denies credential reads, and permission still applies while the read-only sandbox is active. Neither feature needs to know the other exists.
+**Composition with `/ask`**: the two features are independent gates on one bus. Each answers only its own question — ask: "does this mutate?", permission: "does this cross the boundary?" — and either can block. Ask mode still denies credential reads, and permission still applies while the read-only sandbox is active. Neither feature needs to know the other exists. The one exception is ask's `scratchpad`: that tool is self-jailed (relative names only, one temp directory), so ask marks it while active and permission skips the boundary dialog that would otherwise fire for an "outside write" on every note.
 
 **Enable it for every session** (the state itself is never persisted — this is the opt-in):
 
@@ -355,10 +361,12 @@ pnpm check:compat        # verify the declared pi range: last 4 minor lines + 8-
 src/
 ├── index.ts              # entry point: aggregates feature modules
 ├── lib/                  # shared infrastructure (tool-set snapshot/restore,
-│                         # gate bus composing tool_call policies,
+│                         # gate bus composing tool_call policies, jailed-tool
+│                         # registry the boundary gate consults,
 │                         # model-key resolution shared by review & compact)
 └── features/             # feature modules — one directory per feature
     ├── ask/              # ask mode: command + state machine, bash sandbox,
+    │                     #           scratch notes (temp dir + scratchpad tool),
     │                     #           system prompt banner, tests
     ├── autostart/        # session startup automation: autostart.toml parsing,
     │                     #           command pre-validation + replay, tests

package/README.zh-CN.md

@@ -7,6 +7,7 @@
 > pi 编码代理的集成扩展工具包 — 一个包,持续生长新能力。
 
 [![npm version](https://img.shields.io/npm/v/@andares/pi-toolkits?label=npm&logo=npm)](https://www.npmjs.com/package/@andares/pi-toolkits)
+[![Pi package gallery](https://img.shields.io/badge/pi.dev-package%20gallery-6f42c1)](https://pi.dev/packages/@andares/pi-toolkits)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 [![Package Manager](https://img.shields.io/badge/package%20manager-pnpm-orange?logo=pnpm)](https://pnpm.io)
 [![pi >= 1.0](https://img.shields.io/badge/pi-%3E%3D1.0.0%20%3C1.12.0-blueviolet)](https://github.com/earendil-works/pi)
@@ -14,7 +15,7 @@
 
 一句话介绍:目前包含七个开箱即用的功能——**只读咨询模式** `ask`、**会话级边界权限** `ask-perm`、**模型收藏** `favorites`、**提示词暂存** `stash`、**第三方代码评审** `third-review`、**独立压缩模型** `compact-model`、**会话启动自动化** `autostart`,后续持续追加。
 
-**版本要求**:pi `>=1.0.0 <1.12.0` —— 最近 4 个中版本线(1.0.x / 1.1.x / 1.2.x / 1.3.x)尽力支持,上界编码「向后探针」的硬上限:宿主每发一版,我们最多向后查 **8 条中版本线**(当前 1.4 … 1.11),再晚不宣称。**实测自然兼容最高 1.3.0**(写此文时的最新版本,更新的还没发布、无物可探)。一条命令 `pnpm check:compat` 从 registry 推导目标集合,逐版本在系统临时目录沙箱中(把整个 `@earendil-works/*` 家族钉在待测版本)跑:安装 → `tsc --noEmit` → 全量测试 → 键位审计 → 对 patch/mirror 的宿主 `dist` 文件做哈希比对。1.0.0 → 1.3.0 全部 8 个已发布版本:typecheck、397 个测试、键位审计全绿;被跟踪的宿主文件仅在 `core/agent-session.js`(1.3.0 改了 tool-restore 路径,`cycleModel` 未动)、`core/keybindings.js` 与 `core/compaction/utils.js`(二者都是 1.2.0 变的,我们按键的解析结果不变)、`extensions/types.d.ts`(纯增量)上有差异 —— `ModelSelectorComponent`、`core/compaction/compaction.js` 与 `core/usage-totals.js` 在窗口内字节级不变。真实 pi 1.3.0 冒烟加载无警告。注:pi ≥ 0.99 的宿主要求 `@earendil-works/pi-tui` 声明为 peerDependencies `"*"`(由宿主提供),本包已按要求声明。
+**版本要求**:pi `>=1.0.0 <1.12.0` —— 最近 4 个中版本线(1.0.x / 1.1.x / 1.2.x / 1.3.x)尽力支持,上界编码「向后探针」的硬上限:宿主每发一版,我们最多向后查 **8 条中版本线**(当前 1.4 … 1.11),再晚不宣称。**实测自然兼容最高 1.3.0**(写此文时的最新版本,更新的还没发布、无物可探)。一条命令 `pnpm check:compat` 从 registry 推导目标集合,逐版本在系统临时目录沙箱中(把整个 `@earendil-works/*` 家族钉在待测版本)跑:安装 → `tsc --noEmit` → 全量测试 → 键位审计 → 对 patch/mirror 的宿主 `dist` 文件做哈希比对。1.0.0 → 1.3.0 全部 8 个已发布版本:typecheck、473 个测试、键位审计全绿;被跟踪的宿主文件仅在 `core/agent-session.js`(1.3.0 改了 tool-restore 路径,`cycleModel` 未动)、`core/keybindings.js` 与 `core/compaction/utils.js`(二者都是 1.2.0 变的,我们按键的解析结果不变)、`extensions/types.d.ts`(纯增量)上有差异 —— `ModelSelectorComponent`、`core/compaction/compaction.js` 与 `core/usage-totals.js` 在窗口内字节级不变。真实 pi 1.3.0 冒烟加载无警告。注:pi ≥ 0.99 的宿主要求「宿主提供的包」一律声明为 peerDependencies `"*"` —— `@earendil-works/pi-tui` 与 `typebox`(ask 的 `scratchpad` 用它构造参数 schema)都按此声明;若放进 `dependencies`,pi 会告警。
 
 ---
 
@@ -23,7 +24,8 @@
 <a name="install"></a>
 
 ```bash
-# 从 npm 安装(推荐)
+# 从 npm 安装(推荐) —— 也已收录进 pi 官方包编目
+# https://pi.dev/packages/@andares/pi-toolkits
 pi install npm:@andares/pi-toolkits
 
 # 本地开发安装
@@ -35,7 +37,7 @@ pi -e ./src/index.ts
 
 安装后在任意 pi 会话中验证:
 
-- `/ask` → footer 出现灰色 `ask` 状态,`write`/`edit` 被硬禁用
+- `/ask` → footer 出现灰色 `ask` 状态,`write`/`edit` 被硬禁用,同时出现 `scratchpad` 工具用于草稿笔记
 - `/model`(或 `ctrl+l`)→ 选择器顶部出现收藏提示行;对选中模型按 `ctrl+A` → 文字变**加粗亮黄**、收藏计数 +1(这一步同时就是真机按键检查,见「键位」约定)
 - 输入框内按 `ctrl+alt+y` → 当前提示词被暂存并清空输入框
 - 完成一个开发任务后输入 `/third-review` → 切换到评审模型执行查+修
@@ -66,7 +68,7 @@ pi -e ./src/index.ts
 
 | 功能 | 入口 | 一句话说明 |
 | --- | --- | --- |
-| 🛡️ **ask** 只读咨询模式 | `/ask` | 进入只读问答模式,`write`/`edit`/`powershell` 硬禁用,`bash` 只读沙箱,临时启用 `grep`/`find`/`ls` |
+| 🛡️ **ask** 只读咨询模式 | `/ask` | 进入咨询模式:`write`/`edit`/`powershell` 硬禁用,`bash` 只读沙箱,临时启用 `grep`/`find`/`ls`,并开放 `scratchpad` 把草稿写进会话临时目录 |
 | 🔐 **permission** 会话级边界权限 | `/ask-perm` | 项目内/外 × 读/写四格模式,默认关闭且从不落盘;项目外写询问、凭据路径硬拒、破坏性命令必问;与 `/ask` 并行组合 |
 | ⭐ **favorites** 模型收藏 | `/model` 内 `ctrl+A` / `ctrl+J` | 收藏常用模型(加粗亮黄标记),`ctrl+p` 仅在收藏间循环 |
 | 📥 **stash** 提示词暂存 | `ctrl+alt+y` | 一段提示词的暂存槽,按键交换 / 连按两次暂存并清空输入框 |
@@ -80,17 +82,21 @@ pi -e ./src/index.ts
 
 <a name="ask"></a>
 
-用 `/ask` 进入(再按一次退出)。适合只想要"问问题、读代码",绝不希望模型改动任何文件的场景。
+用 `/ask` 进入(再按一次退出)。适合只想要「问问题、读代码」的场景:模型不能改项目,但不会被剥夺思考的落点。
 
 **进入后**:
 
-- **`write` / `edit` / `powershell` 硬禁用** —— 从活跃工具集中移除,pi 运行时对未激活工具的调用直接拒绝("Tool not found"),文件修改在机制上不可能发生
+- **项目文件写入仍然机制上不可能** —— `write` / `edit` / `powershell` 从活跃工具集中移除,pi 对未激活工具的调用直接拒绝("Tool not found");闸门还会二次拦截,防止有东西把它们重新打开
+- **只留一个写通道:`scratchpad`** —— 参数是**相对**笔记名(`plan.md`、`notes/api.md`),只能落到 `<os.tmpdir()>/pi-ask/<session-id>`。它注册时处于未激活状态(`defaultActive: false`),只在 ask 模式里启用,所以它的声明与「笔记不是交付物」的 guidelines 恰好在适用时才进入请求。单文件上限 256 KiB,路径上已存在的符号链接会被拒绝,里面的东西永不被执行—— bash 沙箱因此完全不需要写权限。宿主没有可写临时目录时工具保持未激活,模式降级为旧的纯只读(进入时的提示会说清楚,不做半开)
 - **临时启用只读检索工具** —— `grep` / `find` / `ls`(宿主已注册但默认不激活)在 ask 期间打开,让模型有正规搜索工具而不是只能走 bash;退出时按进入前快照完整恢复
 - **`bash` 保留但只读沙箱** —— shell 分词 + 逐段校验 + 写盘意图检测。除常见读取命令外,放行 git 考古族(`blame`、`grep`、`rev-parse`、`describe`、`shortlog`、`reflog show`、`stash list`、`tag -l`、`cat-file` 等)、包元数据查询(`pnpm view`、`pip show/list`、`python -m json.tool`),以及网络读取 `curl -s <url>` / `wget -O - <url>`。仍拦截:重定向、`tee`、`dd`、`sed -i`、安装/构建、git 变更类命令、命令替换、会启动其它程序的选项(`find -exec`、`git grep -O`、`rg --pre`),以及一切写盘目标(`curl -o`、`wget -O file`、`git diff --output=`、`tree -o`)。启发式,非安全边界
-- **系统提示词给出替代方案** —— 追加的模式说明不仅列限制,还写明被拦后用什么替代(读文件用 `read`、取网页用 `curl -s`、要改动则 `/ask` 退出);被拒的工具调用返回分类原因,直接指向最近的可用替代,模型不会盲目重试
-- **灰色 `ask` footer 状态** —— 常驻提示当前处于只读模式
+- **短横幅而不是清单** —— 系统提示词只追加三行:咨询模式、草稿通道、退出方式。**不再重述 bash 白名单** —— 那是沙箱的职责,被拦时的拒绝理由会直接指出可用的替代,所以细节只在真用到的那一轮付费(旧横幅每个请求都要重申一遍,约 300 token)。横幅不含路径与时间戳,会话内字节稳定,可以稳定命中 provider 的提示词缓存
+- **拒绝理由指向下一步** —— 被拦的 `write` / `edit` 会说明草稿用 `scratchpad`、真正改动要 `/ask` 退出;被拦的重定向也同样指路,而不是只说「不能写」
+- **灰色 `ask` footer 状态** —— 常驻提示当前处于咨询模式
 
-**退出**:再按 `/ask`,完整恢复进入前的工具集快照(含临时启用的只读工具)。
+**草稿生命周期**:每个会话一个目录,位于系统临时目录(`os.tmpdir()`,所以 Windows 的 `%TEMP%` 也适用);进入时创建、退出时**不删**——续会话(`pi -c`)还能找回笔记,进程内切换会话(/new、/resume、fork)会重新绑定到新会话的目录;进入时清掉超过 7 天的旧目录。开启提示会打印路径;里面的内容不属于项目,也不会出现在 `git status` 里。
+
+**退出**:再按 `/ask`,完整恢复进入前的工具集快照(含 scratch 工具与临时启用的只读工具)。
 
 ---
 
@@ -356,9 +362,11 @@ src/
 ├── index.ts              # 入口:聚合各功能模块
 ├── lib/                  # 共享基础设施(工具集快照/恢复、
 │                         # 组合 tool_call 策略的闸门总线、
+│                         # 边界闸门会查询的自封闭工具登记表、
 │                         # review 与 compact 共用的模型 key 解析)
 └── features/             # 功能模块 —— 一个功能一个目录
     ├── ask/              # ask 模式:命令 + 状态机、bash 沙箱、
+    │                     #           草稿空间(临时目录 + scratchpad 工具)、
     │                     #           系统提示词横幅、测试
     ├── autostart/        # 会话启动自动化:autostart.toml 解析、
     │                     #           命令预校验 + 重放、测试

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@andares/pi-toolkits",
-  "version": "0.9.5",
+  "version": "0.9.7",
   "description": "Integrated toolkit extension for pi — ask mode (read-only Q&A), session-scoped permission checks, model favorites, prompt stash, third-party code review, session autostart, and a dedicated compaction model",
   "type": "module",
   "license": "MIT",
@@ -15,6 +15,8 @@
     "src"
   ],
   "keywords": [
+    "pi-package",
+    "pi-coding-agent",
     "pi",
     "pi-extension",
     "ask-mode",
@@ -32,7 +34,8 @@
   ],
   "peerDependencies": {
     "@earendil-works/pi-coding-agent": ">=1.0.0 <1.12.0",
-    "@earendil-works/pi-tui": "*"
+    "@earendil-works/pi-tui": "*",
+    "typebox": "*"
   },
   "dependencies": {
     "@dreki-gg/pi-command-sandbox": "^0.4.3",
@@ -44,6 +47,7 @@
     "@earendil-works/pi-coding-agent": "^1.3.0",
     "@earendil-works/pi-tui": "^1.3.0",
     "@types/node": "^26.6.2",
+    "typebox": "^1.3.27",
     "typescript": "^5.6.0",
     "vitest": "^4.1.10"
   },

package/src/features/ask/constants.ts

@@ -8,6 +8,11 @@
  * `write`/`edit` are the obvious ones. `powershell` is a shell too: pi
  * registers it on every platform (inactive by default, enabled by settings),
  * and it would otherwise hand ask mode a full write channel.
+ *
+ * The one write channel ask mode keeps is its own tool, {@link ASK_SCRATCH_TOOL}:
+ * it takes a relative note name and can only reach the session's scratch
+ * directory (see scratch.ts), so it needs no path check from the model and no
+ * write allowance in the bash sandbox.
  */
 export const ASK_BLOCKED_TOOLS: ReadonlySet<string> = new Set([
 	"write",
@@ -23,6 +28,13 @@ export const ASK_BLOCKED_TOOLS: ReadonlySet<string> = new Set([
  */
 export const ASK_READ_ONLY_HELPERS: readonly string[] = ["grep", "find", "ls"];
 
+/**
+ * The scratch-note tool. Registered inactive (`defaultActive: false`) and
+ * activated only while ask mode is on, so its declaration and
+ * `promptGuidelines` are part of the request exactly when they apply.
+ */
+export const ASK_SCRATCH_TOOL = "scratchpad";
+
 /** Footer status key (extension-scoped) and label. */
 export const ASK_STATUS_KEY = "ask-mode";
 export const ASK_STATUS_LABEL = "ask";

package/src/features/ask/index.test.ts

@@ -1,18 +1,22 @@
 /**
  * ask mode over the gate bus.
  *
- * The feature's command/state behaviour predates the bus; what this covers is
- * the migration itself: while ask mode is on, its gate blocks the tools it
- * confiscates and non-read-only bash, and it stops speaking once the mode is
- * off.
+ * Covers the state machine (tool snapshot, scratch tool activation, jailed-tool
+ * registration), the gate's verdicts, and the degradation path when the session
+ * has no writable temp directory.
  */
-import { describe, expect, it } from "vitest";
+import { mkdtempSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join, resolve } from "node:path";
+import { beforeEach, describe, expect, it } from "vitest";
 import type {
 	ExtensionAPI,
 	ExtensionContext,
 	ToolCallEvent,
 } from "@earendil-works/pi-coding-agent";
 import type { GateHub, ToolGate } from "../../lib/gates.js";
+import { isJailedTool, resetJailedTools } from "../../lib/tools.js";
+import { ASK_SCRATCH_TOOL } from "./constants.js";
 import { registerAsk } from "./index.js";
 
 function event(toolName: string, input: Record<string, unknown> = {}): ToolCallEvent {
@@ -24,7 +28,11 @@ function event(toolName: string, input: Record<string, unknown> = {}): ToolCallE
 	} as unknown as ToolCallEvent;
 }
 
-function makeHarness() {
+function tempBase(): string {
+	return mkdtempSync(join(tmpdir(), "pi-ask-mode-"));
+}
+
+function makeHarness(options: { scratchBaseDir?: string } = {}) {
 	const captured: ToolGate[] = [];
 	const hub = {
 		register(gate: ToolGate) {
@@ -36,19 +44,27 @@ function makeHarness() {
 
 	let activeTools = ["read", "write", "edit", "bash"];
 	let commandHandler: ((args: string, ctx: ExtensionContext) => unknown) | undefined;
+	let registeredTool: { defaultActive?: boolean; name: string } | undefined;
+	const handlers = new Map<string, (event: unknown, ctx: ExtensionContext) => unknown>();
 	const pi = {
-		on: () => {},
+		on(name: string, handler: (event: unknown, ctx: ExtensionContext) => unknown) {
+			handlers.set(name, handler);
+		},
 		registerCommand(
 			name: string,
 			options: { handler: (args: string, ctx: ExtensionContext) => unknown },
 		) {
 			if (name === "ask") commandHandler = options.handler;
 		},
+		registerTool(tool: { defaultActive?: boolean; name: string }) {
+			registeredTool = tool;
+		},
 		getActiveTools: () => [...activeTools],
 		getAllTools: () => [
 			{ name: "grep" },
 			{ name: "find" },
 			{ name: "ls" },
+			{ name: ASK_SCRATCH_TOOL },
 		],
 		setActiveTools: (names: string[]) => {
 			activeTools = [...names];
@@ -56,41 +72,61 @@ function makeHarness() {
 	} as unknown as ExtensionAPI;
 
 	const statuses: Array<[string, string | undefined]> = [];
-	const notes: string[] = [];
+	const notes: Array<{ message: string; kind?: string }> = [];
+	let sessionId = "session-1";
 	const ctx = {
 		hasUI: true,
 		mode: "tui",
 		ui: {
-			notify: (message: string) => notes.push(message),
+			notify: (message: string, kind?: string) => notes.push({ message, kind }),
 			setStatus: (key: string, value: string | undefined) => statuses.push([key, value]),
 			theme: { fg: (_color: string, text: string) => text },
 		},
+		sessionManager: { getSessionId: () => sessionId },
 	} as unknown as ExtensionContext;
 
-	registerAsk(pi, hub);
+	registerAsk(pi, hub, options);
 	const gate = captured[0];
 	if (!gate || !commandHandler) throw new Error("ask did not register");
 
 	return {
 		gate,
 		ctx,
+		notes,
 		activeTools: () => activeTools,
+		registeredTool: () => registeredTool,
+		setSessionId: (id: string) => {
+			sessionId = id;
+		},
+		sessionStart: async () => {
+			await handlers.get("session_start")?.({ reason: "new" }, ctx);
+		},
 		toggle: async () => {
 			await commandHandler?.("", ctx);
 		},
 		evaluate: async (toolName: string, input: Record<string, unknown> = {}) =>
 			gate.evaluate(event(toolName, input), ctx),
+		banner: () =>
+			handlers.get("before_agent_start")?.(
+				{ type: "before_agent_start", systemPrompt: "base" },
+				ctx,
+			) as { systemPrompt: string } | undefined,
 	};
 }
 
+beforeEach(() => {
+	// The jail registry is module state; one test's mark must not leak into the next.
+	resetJailedTools();
+});
+
 describe("ask gate", () => {
 	it("has no opinion while ask mode is off", async () => {
-		const h = makeHarness();
+		const h = makeHarness({ scratchBaseDir: tempBase() });
 		expect(await h.evaluate("write", { path: "x" })).toBeUndefined();
 	});
 
 	it("blocks confiscated tools and non-read-only bash while on", async () => {
-		const h = makeHarness();
+		const h = makeHarness({ scratchBaseDir: tempBase() });
 		await h.toggle();
 		expect(await h.evaluate("write", { path: "x" })).toMatchObject({
 			kind: "block",
@@ -102,17 +138,124 @@ describe("ask gate", () => {
 	});
 
 	it("stops blocking after exiting", async () => {
-		const h = makeHarness();
+		const h = makeHarness({ scratchBaseDir: tempBase() });
 		await h.toggle();
 		await h.toggle();
 		expect(await h.evaluate("write", { path: "x" })).toBeUndefined();
 	});
+});
+
+describe("ask tool set", () => {
+	it("registers the scratch tool inactive", async () => {
+		const h = makeHarness({ scratchBaseDir: tempBase() });
+		expect(h.registeredTool()?.name).toBe(ASK_SCRATCH_TOOL);
+		expect(h.registeredTool()?.defaultActive).toBe(false);
+	});
+
+	it("activates scratchpad and marks it jailed only while on", async () => {
+		const h = makeHarness({ scratchBaseDir: tempBase() });
+		await h.toggle();
+		expect(h.activeTools()).toContain(ASK_SCRATCH_TOOL);
+		expect(isJailedTool(ASK_SCRATCH_TOOL)).toBe(true);
+
+		await h.toggle();
+		expect(h.activeTools()).not.toContain(ASK_SCRATCH_TOOL);
+		expect(isJailedTool(ASK_SCRATCH_TOOL)).toBe(false);
+	});
 
-	it("restores the tool snapshot on exit", async () => {
-		const h = makeHarness();
+	it("restores the entry snapshot on exit", async () => {
+		const h = makeHarness({ scratchBaseDir: tempBase() });
 		await h.toggle();
 		expect(h.activeTools()).not.toContain("write");
 		await h.toggle();
 		expect(h.activeTools()).toEqual(["read", "write", "edit", "bash"]);
 	});
+
+	it("adds the read-only helpers that were inactive", async () => {
+		const h = makeHarness({ scratchBaseDir: tempBase() });
+		await h.toggle();
+		expect(h.activeTools()).toEqual(
+			expect.arrayContaining(["grep", "find", "ls"]),
+		);
+	});
+});
+
+describe("ask scratch availability", () => {
+	it("creates the scratch directory under the configured base", async () => {
+		const base = tempBase();
+		const h = makeHarness({ scratchBaseDir: base });
+		await h.toggle();
+		expect(h.notes.at(-1)?.message).toContain(resolve(base));
+	});
+
+	it("degrades to fully read-only when the temp dir is unusable", async () => {
+		const base = tempBase();
+		const file = join(base, "not-a-dir");
+		writeFileSync(file, "x");
+		const h = makeHarness({ scratchBaseDir: file });
+		await h.toggle();
+
+		expect(h.activeTools()).not.toContain(ASK_SCRATCH_TOOL);
+		expect(isJailedTool(ASK_SCRATCH_TOOL)).toBe(false);
+		expect(h.notes.at(-1)?.message).toContain("read-only");
+		const warning = h.notes.find((note) => note.kind === "warning");
+		expect(warning?.message).toContain("no scratch space");
+		// Still a consult mode: the hard block is unchanged.
+		expect(await h.evaluate("write", { path: "x" })).toMatchObject({
+			kind: "block",
+		});
+		expect(h.banner()?.systemPrompt).not.toContain(ASK_SCRATCH_TOOL);
+	});
+});
+
+describe("ask banner", () => {
+	it("names the scratch channel while it exists", async () => {
+		const h = makeHarness({ scratchBaseDir: tempBase() });
+		await h.toggle();
+		const banner = h.banner()?.systemPrompt ?? "";
+		expect(banner).toContain("[ASK MODE]");
+		expect(banner).toContain(ASK_SCRATCH_TOOL);
+		expect(banner).toContain("/ask");
+	});
+
+	it("stays silent when the mode is off", () => {
+		const h = makeHarness({ scratchBaseDir: tempBase() });
+		expect(h.banner()).toBeUndefined();
+	});
+});
+
+describe("ask session rebinding", () => {
+	it("rebinds the scratch directory when the session changes while on", async () => {
+		const base = tempBase();
+		const h = makeHarness({ scratchBaseDir: base });
+		await h.toggle();
+		const firstNotice = h.notes.at(-1)?.message ?? "";
+		expect(firstNotice).toContain("notes go to");
+
+		h.setSessionId("session-2");
+		await h.sessionStart();
+
+		const rebind = h.notes.at(-1)?.message ?? "";
+		expect(rebind).toContain("notes now go to");
+		// The two notices name different per-session directories.
+		const firstRoot = firstNotice.match(/notes go to (.+)\. \//)?.[1];
+		const reboundRoot = rebind.match(/notes now go to (.+)\./)?.[1];
+		expect(firstRoot).toBeDefined();
+		expect(reboundRoot).toBeDefined();
+		expect(reboundRoot).not.toBe(firstRoot);
+	});
+
+	it("keeps the scratch directory on a repeated emission for the same session", async () => {
+		const h = makeHarness({ scratchBaseDir: tempBase() });
+		await h.toggle();
+		const noteCount = h.notes.length;
+		await h.sessionStart();
+		expect(h.notes.length).toBe(noteCount);
+	});
+
+	it("does nothing while the mode is off", async () => {
+		const h = makeHarness({ scratchBaseDir: tempBase() });
+		await h.sessionStart();
+		expect(h.notes).toHaveLength(0);
+	});
 });