vultr/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-03-18 05:20:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: address review feedback on context-engine page

Browse Source 
- Rename 'Method' column to 'Member' with explicit Kind column since
  info is a property, not a callable method
- Document AssembleResult fields (estimatedTokens, systemPromptAddition)
  with types and optionality
- Add lifecycle timing notes for bootstrap, ingestBatch, and dispose
  so plugin authors know when each is invoked
This commit is contained in:
Josh Lehman
2026-03-14 18:03:06 -07:00
parent 315cee96b9
commit 9887311de3
1 changed files with 23 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/concepts/context-engine.md
View File

@@ -163,25 +163,32 @@ Then enable it in config:
### The ContextEngine interface
Required methods:
Required members:
| Method | Purpose |
| ------------------ | -------------------------------------------------------- |
| `info` | Engine id, name, version, and whether it owns compaction |
| `ingest(params)` | Store a single message |
| `assemble(params)` | Build context for a model run |
| `compact(params)` | Summarize/reduce context |
| Member | Kind | Purpose |
| ------------------ | -------- | -------------------------------------------------------- |
| `info` | Property | Engine id, name, version, and whether it owns compaction |
| `ingest(params)` | Method | Store a single message |
| `assemble(params)` | Method | Build context for a model run (returns `AssembleResult`) |
| `compact(params)` | Method | Summarize/reduce context |
Optional methods:
`assemble` returns an `AssembleResult` with:
- `messages` — the ordered messages to send to the model.
- `estimatedTokens` (required, `number`) — the engine's estimate of total
tokens in the assembled context. OpenClaw uses this for compaction threshold
decisions and diagnostic reporting.
- `systemPromptAddition` (optional, `string`) — prepended to the system prompt.
| Method | Purpose |
| ------------------------------ | ----------------------------------------- |
| `bootstrap(params)` | Initialize engine state for a new session |
| `ingestBatch(params)` | Ingest a completed turn as a batch |
| `afterTurn(params)` | Post-run lifecycle work |
| `prepareSubagentSpawn(params)` | Set up shared state for a child session |
| `onSubagentEnded(params)` | Clean up after a subagent ends |
| `dispose()` | Release resources |
Optional members:
| Member | Kind | Purpose |
| ------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------- |
| `bootstrap(params)` | Method | Initialize engine state for a session. Called once when the engine first sees a session (e.g., import history). |
| `ingestBatch(params)` | Method | Ingest a completed turn as a batch. Called after a run completes, with all messages from that turn at once. |
| `afterTurn(params)` | Method | Post-run lifecycle work (persist state, trigger background compaction). |
| `prepareSubagentSpawn(params)` | Method | Set up shared state for a child session. |
| `onSubagentEnded(params)` | Method | Clean up after a subagent ends. |
| `dispose()` | Method | Release resources. Called during gateway shutdown or plugin reload — not per-session.
### ownsCompaction