Role
Lets the agent “remember facts across sessions” while keeping the conversation context bounded. Harness splits memory into two layers:- Layer 1 · daily log
memory/YYYY-MM-DD.md— append-only each day, raw and not deduped; - Layer 2 · curated long-term
MEMORY.md— periodically merged + deduped by the LLM; injected into the system prompt every reasoning step as long-term memory.
- Conversation compaction — summarizes history and keeps a recent tail when context is too long;
- Overflow safety net — when the model actually errors, force a compaction and retry;
- Large tool-result offloading — offload to disk + placeholder when a single tool returns too much.
The three LLM calls at a glance
The memory pipeline runs three independent LLM calls, each with its own prompt and triggering rules. This is the easiest place to get confused when customizing:
The first two are “long-term memory settling” and live on
MemoryConfig; the third is “in-context compression” and lives on CompactionConfig. All three LLM calls share the agent’s primary model by default, but MemoryConfig and CompactionConfig each support a .model(...) override so you can use a lighter model for these auxiliary operations.
How the two layers work
Key points:- Layer 1 only appends, never dedupes; Layer 2 is periodically rewritten as a whole; the two layers never overwrite each other.
- Layer 2 is the only one injected into the prompt; Layer 1 waits to be merged.
- Raw messages dropped during compaction are also saved into a never-compacted log file (
*.log.jsonl) for later audit orsession_search.
When flush fires
Flush (path 1) is triggered at three different moments:- End of every
call()— the defaultMemoryFlushMiddlewarebehaviour. Can be retuned toNEVERorTHROTTLED(Duration)viaflushTrigger. - Pre-compaction extraction — when
CompactionConfig.flushBeforeCompact = true(default), the conversation prefix is flushed once before being summarized. - Overflow safety net — when the model actually returns
context_length_exceeded, the framework runs an emergency compaction that includes a flush.
flushPrompt, so customizing it changes all three.
Both flush and offload are asynchronous: they are launched in a fire-and-forget fashion via doOnComplete after the response stream has ended, so they never block the current call() return. The caller receives the full response first; the flush LLM call and JSONL offload run in the background afterward.
Enable compaction
Auto-recovery on overflow: when the model returns
context_length_exceeded (or similar), the framework forces one compaction and retries — but only when compaction(...) is configured; otherwise the error propagates.
Want it lighter? Trim arguments first
Tool calls likewrite_file carry huge arguments that nobody reads later. Before LLM summarization you can run a non-LLM string truncation:
Customizing the memory pipeline: MemoryConfig
MemoryConfig is the single place to configure flush / consolidation prompts, throttling, retention, and the per-call flush trigger. Every field has a default; not calling .memory(...) reproduces the historical behaviour bit-for-bit.
Per-call flush and background consolidation have independent throttle windows. In both cases, the first eligible call() runs the work immediately; a minimum gap limits only subsequent runs and is not an initial delay.
Example 1: throttle per-call flush to save tokens
A flush LLM call after every agent invocation can add up on long sessions. Throttle it to at most once every 10 minutes:THROTTLEDonly affects path 1 (per-call flush). The flush embedded in compaction (path 2) and the overflow flush (path 3) still fire on their own triggers — compaction is rare, so those two are infrequent by construction.- The first eligible call flushes immediately;
Duration.ofMinutes(10)limits only later per-call flushes. - Offload is unaffected, the session JSONL is still written in full every call.
session_searchand session resumption keep working.
Example 2: disable per-call flush entirely
To turn off flush and background maintenance use.disableMemoryHooks();flushTrigger(NEVER)only stops the per-call flush — background consolidation still runs.
Example 3: extend the default prompt with project rules
Example 4: fully custom consolidation prompt
Important: a custom consolidation prompt must contain exactly two%dplaceholders (max-tokens then max-chars). The Builder rejects anything else at construction time so you don’t hit a runtimeMissingFormatArgumentException.
Example 5: tune background maintenance
Example 6: use a smaller model for memory operations
Flush and consolidation don’t need the full power of the primary reasoning model — use a cheaper one to save cost:model(String) resolves via ModelRegistry.resolve(); you can also pass a Model instance. When not set, falls back to the agent’s primary model.
MemoryConfig field reference
Large tool-result offloading
Independent of compaction. When a single tool call returns more than the threshold, the full text is written to a directory and only a head/tail preview + a placeholder is left in context. The agent canread_file for the full content:
- Triggered at 80K characters
- Keeps ~2K chars at head + tail + a line “full content at
{path}” read_fileis excluded by default (to avoid re-offloading what was just read back)
ToolResultEvictionConfig.builder()...build().
Tools the agent can use itself
When memory is enabled, the agent gets two tools:memory_search query="..."— keyword scan overMEMORY.md+memory/*.md, up to 30 hitsmemory_get path="memory/2026-06-02.md" startLine=10 endLine=40— read a specific line range
memory_search to look further back.
Background maintenance
When memory is enabled, a throttled background job also runs. The first eligiblecall() runs it immediately; later calls observe the minimum gap (30 minutes by default):
- Archives daily logs older than
dailyFileRetentionDays(default 90 days) tomemory/archive/ - Runs one
MEMORY.mdconsolidation pass - Prunes session logs older than
sessionRetentionDays(default 180 days)
FlushTrigger.never() does not disable this maintenance path.
All thresholds are tunable via .memory(MemoryConfig.builder()...), though most projects don’t need to touch them.
Turn it off entirely
If you want to handle memory yourself or wire your own tools:<memory_context> (MEMORY.md) injection while keeping Domain Knowledge / AGENTS / knowledge context.
disableMemoryHooks() is the nuclear option for background memory work; if you only want to throttle, use .memory(MemoryConfig.builder().flushTrigger(...).build()) instead.
Related Pages
- Workspace — where
MEMORY.md/memory/live in the workspace - Context — the never-compacted
*.log.jsonlconversation log - Architecture — how facts in long conversations settle into
MEMORY.md