pi-compact-assistant

Pi extension that lets the model compact its own conversation at a good moment, before Pi's automatic compaction interrupts it.

• It checks context usage before every model request, including requests between tool calls.
• At the compaction threshold, compactAt, it declares the compact tool and tells the model to record the work's state in a Markdown file, then call compact with the file's path and the next step. Before that threshold and after each compaction, the model has no compact tool.
• compact runs Pi's compaction after the turn ends, then delivers the model's continuation message and resumes the agent.

The instruction is a mid-conversation system message. Anthropic receives it as a system message and OpenAI Codex as a developer message, in place in the conversation. The top-level system prompt, Anthropic's system field or Codex's instructions field, stays unchanged.

Requirements and loading

Tested with Pi 1.4.0 and Node.js 22.23.4. The package requires Pi >=1.4.0 <1.5.0 and Node.js >=22.19.0. The extension refuses to load on a Pi older than 1.4.0, because Pi does not enforce the peer range when it installs packages.

Pi's virtual models are not supported. Pi's experimental virtual models, registered with pi.registerVirtualModel(), are not tested with this package.

From this checkout:

mise run init
mise exec -- pi -e ./extensions/index.ts

This does not change your Pi configuration. Keep other extensions enabled, including any required provider or system-prompt extensions.

Settings

Settings are read from ~/.pi/agent/pi-compact-assistant.json when a session starts. Run /reload after changing the file. A missing file uses the defaults.

{
  "enabled": true,
  "default": { "compactAt": "80%" },
  "models": {
    "anthropic/claude-opus-5-5": { "compactAt": 500000 },
    "anthropic/claude-fable-5-1": { "compactAt": 500000 },
    "openai-codex/gpt-6.1-sol": { "compactAt": "75%" },
    "openai-codex/gpt-5.6-luna": false
  }
}

compactAt is a whole token count, such as 500000, or a percentage of the model's context window, such as "80%". Keys are exact and case-sensitive. Earlier versions also read prepareAt. This version ignores it, so settings files that still set it stay valid.

An invalid file disables the extension for the session. Interactive and RPC sessions show an error.

Keep Pi's automatic compaction as a backstop

Pi compacts automatically when context exceeds contextWindow - reserveTokens. Keep that trigger above compactAt so the model has room to compact first. Pi still compacts if the model ignores the instruction. For example, compact Opus 5.5 at 500,000 tokens with this extension and let Pi compact at 600,000:

{
  "compaction": {
    "modelOverrides": {
      "anthropic/claude-opus-5-5": { "reserveTokens": 400000 }
    }
  }
}

Instructions

The [Compaction required] instruction is recorded once per compaction cycle as a custom session entry. The entry stores the rendered text and the context entry it follows. Before each request, the extension adds the recorded instruction as a system message directly after that entry. The instruction:

• is not stored as a conversation message, so summaries and later prompts never contain it;
• stays at the same position in later requests, so prompt-cache prefixes stay valid;
• stops after a compaction, until usage reaches compactAt again; and
• contains no usage figures, so its text is the same in every session.

The interactive TUI draws the recorded instruction in the transcript as a box with its label and the token count at which it was added. Expand tool output, ctrl+o by default, to see the exact instruction text. The box is not sent to the model. RPC clients get a notice instead.

The instruction tells the model that compaction does not end the task and to act now. The model finishes only a half-applied change. It records the goal, constraints, decisions, changed files, validation results, running processes, open questions, and next step in a Markdown state file. It reuses the task's state file or creates one where project instructions keep working notes, or outside tracked files. It never puts the state in project documentation and never stages or commits the file. Then it calls compact as the only tool call in its response, with the file's absolute path and the exact next step. A model that cannot or may not write files skips the file and puts the full state in the message. After compaction, the continuation tells the model to read the named state file before acting.

Earlier versions also posted a [Compaction preparation] instruction at prepareAt. This version skips such instructions in resumed sessions.

Supported models

The extension instructs only models that meet all of these conditions:

• the provider is anthropic or openai-codex, the request paths the live tests cover;
• Pi marks the model as accepting system messages mid-conversation. Pi 1.4.0 marks Claude Fable 5, Fable 5.1, Opus 4.8, Opus 5, Opus 5.5, Sonnet 5.5, and Haiku 5.5, and the Codex GPT-5.6, GPT-6, and GPT-6.1 models this way. For other models Pi would fold each instruction into the leading system prompt, which changes the cached prefix; and
• for openai-codex, a loaded pi-openai-codex-compat is 0.0.23 or later. The extension reads its version from the loaded package. Older versions drop the instruction from Codex requests.

Other models get no instructions, even ones recorded while a supported model was selected. A model with its own settings entry, or any Codex model with an outdated pi-openai-codex-compat, shows an error once per session in interactive and RPC sessions. Models covered only by default are skipped silently.

The compact tool is declared only to supported models that the settings enable. Unsupported models and disabled models do not get it. A model is disabled when its entry under models is false, when it has no entry and default is false, when enabled is false, or when the settings file is invalid.

When compact is declared

The extension declares compact only while compaction is due: context usage is at compactAt, or a [Compaction required] instruction is recorded since the latest compaction. Any compaction withdraws it, including Pi's automatic compaction and /compact. The model cannot compact at the user's request before the threshold.

The extension updates the declaration before each model request: when a run starts, counting the message that starts it, after each tool batch, and after each compaction. It also updates it when a session starts, the model changes, or the session branch changes. Pi appends the change to the transcript, so the tool reaches the model with the same request as the [Compaction required] instruction:

• Anthropic models that accept mid-conversation tool changes receive an inline tool_definition. The request's top-level tools field keeps the first request's tools, so the cached prefix stays valid.
• Pi's built-in Codex provider adds the tool with an additional_tools item in place in the conversation, and the top-level tools field stays unchanged.
• pi-openai-codex-compat sends the complete current tool set in the top-level tools field on every request. Adding compact costs one prompt-cache miss, at the request that carries the compaction instruction.

compact has no system prompt guidelines, so declaring it leaves the system prompt unchanged. The instruction, the tool description, and the cancellation notice carry its guidance.

A message that arrives after a tool batch, such as a large steering message, can pass compactAt after the extension updated the declaration for the next request. That request then gets no [Compaction required] instruction, because it cannot call compact. The extension declares the tool, and the instruction follows with the next request.

compact

{
  message: string;        // required
  instructions?: string;  // optional
}

• message is delivered after compaction succeeds and starts the next turn. It gives the absolute path of the Markdown state file and the exact next step. The file holds the rest of the state. Without a state file, the message holds the full state. If no work is pending, it says so.
• instructions guides the summarizer. It is passed to Pi's compaction as custom instructions. Pi's own summary, pi-anthropic-compat native compaction, and pi-openai-codex-compat remote compaction all apply them; live probes confirmed each native path. The instructions should only select or emphasize conversation content. Anthropic's native compaction refused an instruction to state a fact that was not in the conversation, and a refusal cancels the compaction.

The model must call compact alone. The tool ends the tool batch. When the agent run settles, the extension compacts the session, then sends the message as an agent-authored continuation, which starts the next turn. The continuation states that it is not a new user request or authorization. Print and JSON runs wait for the compaction and the continuation before they exit. The extension adds no command.

Compaction starts in the extension's agent_settled handler. In interactive and RPC sessions, work that another extension sends from its own agent_settled handler arrives while compaction runs. Pi refuses a user message from it, and a custom message that triggers a turn starts a run during compaction.

Queued messages never cancel the request:

• Messages queued before the run ends, from the user or another extension, reach the model as usual before compaction. The tool result tells the model to handle them and keep the state file current.
• User input that arrives after the run ends waits until compaction finishes. Interactive sessions list it above the editor. Pi refuses prompts from other extensions while compaction runs.
• After compaction, the continuation comes first. Held input and messages still in Pi's queue follow it as separate messages, delivered by Pi's steeringMode and followUpMode settings.

The request is cancelled, and the model is told, when:

• the run is aborted; or
• compaction fails or another extension cancels it.

After a cancellation, held input follows the notice as separate messages. The notice tells the model to check the reason and any newer user input before it calls compact again, and to omit or revise instructions after a summarizer refusal. compact stays declared until a compaction succeeds.

Pi reports an extension's cancellation only as "Compaction cancelled". An extension can name its reason on the shared pi.events channel compaction:cancelled as { source, reason }, where reason is a complete sentence. The notice then states that reason and the extension that cancelled, such as "pi-anthropic-compat cancelled it. No recorded safe boundary satisfies native tail retention." Only reasons published while this request's compaction runs count. pi-anthropic-compat 0.0.16 and later publish them.

Cancelled requests are never retried or replayed. compact changes conversation context only, never files, processes, or permissions.

Compat extensions

• pi-anthropic-compat: the native Anthropic compaction handles compact. Live tests pass with Claude Sonnet 5.5.
• Without a compat extension, Pi's built-in Anthropic provider receives the instruction as a system message, and Pi writes the summary. Live tests pass with Claude Sonnet 5.5.
• pi-openai-codex-compat 0.0.23 or later: Codex remote compaction handles compact, and the instruction reaches Codex as a developer message. Live tests pass with GPT-6.1 Sol. Version 0.0.22 and earlier drop the instruction, because they build Codex requests only from the stored session.
• Without a compat extension, Pi's built-in Codex provider receives the instruction as a developer message, and Pi writes the summary. Live tests pass with GPT-6.1 Sol.

Development

mise run init
mise run check
npm test
npm run test:live
npm run pack:dry

npm test runs offline tests with Pi's real session runtime and a scripted provider.

npm run test:live packs the extension and runs the packaged Pi CLI against real providers. It uses your Pi login through an isolated agent directory, loads the pinned system prompt patcher and the provider's compat extension, and checks that the instruction reaches the provider payload as a mid-conversation item beside an unchanged top-level system prompt, the model calls compact, compaction runs, and the agent resumes with earlier facts intact. They also check that the provider payload declares compact only in requests that carry the compaction instruction, that compaction withdraws it, and that the top-level tools field stays unchanged except with pi-openai-codex-compat. Further scenarios first measure the context after a small turn and set compactAt above it, so reading a padding file passes the threshold. The model then calls compact, and the test aborts the run or cancels the compaction and checks that the continuation is withheld with a notice. One of them lets pi-anthropic-compat cancel for real and checks that the notice names its published reason. Two more send user input through RPC while the model calls compact and during compaction. They check that compaction still runs, that the first input reaches the model before compaction, and that the second follows the continuation as its own message. Print runs in text and JSON mode must compact and answer the continuation before they exit. An interactive TUI run, in a pseudo-terminal from the operating system's script utility on macOS or Linux, checks that the recorded instruction appears in the transcript as a box, types input during compaction, and checks that the input follows the continuation. Release validation runs it against the exact release archive.

Packaging

.github/npm-package-files is the authoritative package-content allowlist used by the local release command and both CI jobs. Update it whenever the intended published file set changes.

Release staging

Repository setup:

1. When new creates the GitHub repository, it automatically protects main and v* tags and restricts npm-publish to v* tags without a deployment reviewer or administrator bypass.
2. Configure npm trusted publishing for 2h2d-co/pi-compact-assistant using .github/workflows/publish.yml and the npm-publish environment.
3. Replace .github/release-signers if release commits use a different SSH signing key.

Release flow:

1. Run npm run release -- X.Y.Z from a clean, synchronized main. It runs the live test against the exact staged archive before signing.
2. The release command packs the package from the staged Git index, records its SHA-256 in the SSH-signed release commit, rebuilds the commit to prove reproducibility, and creates a lightweight vX.Y.Z tag.
3. Inspect the commit and tag, then push them atomically with git push --atomic origin main vX.Y.Z.
4. A read-only CI job tests, packs, and inspects the package without publishing credentials.
5. A separate credentialed job verifies the signed commit and exact package digest before attesting and staging that archive through npm trusted publishing.
6. A final job creates the immutable GitHub release for the tag from the same verified archive, its checksum, and the version's CHANGELOG.md section (Unreleased for prereleases).
7. Approve the staged package on npmjs.com or with npm stage approve <stage-id>.

Stable versions use latest; prereleases derive a non-latest dist-tag such as alpha, beta, or rc from their first prerelease identifier.