docs: document package KV cache effects

This commit is contained in:
Tianyi Cui
2026-07-19 17:39:50 +08:00
parent b3c4b732d8
commit bcc920369c
93 changed files with 366 additions and 34 deletions

View File

@@ -46,6 +46,8 @@ Constraints: `suite.ts` imports vitest, so the package entry is importable only
None, as this test-only harness records, normalizes, and compares ACP transcripts without changing the agent's assembled model request.
**KV Cache effect**: None; this package neither assembles nor sends a provider request.
## Known Limitations and Deferred Work
- **Session harvest is JSONL-only** — `runScenario` collects persisted `.jsonl` logs, so an example composed over the SQLite persistence backend has no snapshot path.

View File

@@ -22,6 +22,8 @@ Tests of injection failures, partial topology, service load order, or service te
None, as this test-only composition helper neither drives nor modifies model requests.
**KV Cache effect**: None; this package neither assembles nor sends a provider request.
## Known Limitations and Deferred Work
- **Only the mandatory prerequisite spine is shared** — adapters, optional plugins, `AgentLoop`, agents, and Context teardown remain caller-owned so scenario-specific ordering stays visible.

View File

@@ -56,6 +56,8 @@ A seeded or forked session arrives with events already in its log because constr
None, as this observer only validates events and frozen requests and never rewrites prompts, schemas, messages, or streams.
**KV Cache effect**: None; this package neither assembles nor sends a provider request.
## Known Limitations and Deferred Work
- **The request-reconstructability assertion covers loop-built requests only** — hand-built one-shots (e.g. compaction's summarize call) carry no live `sessionId` marker and are skipped.

View File

@@ -56,6 +56,8 @@ Named `name` / `inject` / `Config` / `apply`, with **no default export**: the co
None, as this keyless test adapter sends no request to a provider model; it only replays recorded assistant chunks into the test loop.
**KV Cache effect**: None; this package neither assembles nor sends a provider request.
## Known Limitations and Deferred Work
- **First-call-order script binding assumes sequential delegation** — a cut that runs sibling subagents concurrently (or a compaction summarize call landing mid-run) would bind live sessions to recorded scripts non-deterministically; a stronger keying is deferred until such a scenario exists (`XXX(concurrent-subagents)`).

View File

@@ -10,6 +10,8 @@ This is support-tier test infrastructure, not product API.
None, as this test-only harness boots example processes and inspects their streams without changing an assembled model request.
**KV Cache effect**: None; this package neither assembles nor sends a provider request.
## Known Limitations and Deferred Work
- **Built mode requires a prior build** — the config must also resolve every named package upward through `examples/node_modules`.