Class MemoryReflectTool

ITool implementation that triggers one full memory consolidation cycle via ().

Usage:

const tool = new MemoryReflectTool(brain, consolidationLoop);
const result = await tool.execute({}, context);
// result.output → { pruned: 3, merged: 1, derived: 0, compacted: 2, durationMs: 42 }

Implements

ITool<MemoryReflectInput, MemoryConsolidationResult>

Index

Constructors

constructor

new MemoryReflectTool(brain, consolidation): MemoryReflectTool
Parameters
- brain: SqliteBrain
  The agent's shared SQLite brain database connection. Accepted for symmetry with other memory tools and for future direct consolidation calls.
- consolidation: ConsolidationLoop
  The ConsolidationLoop instance to invoke.
Returns MemoryReflectTool
- Defined in src/memory/io/tools/MemoryReflectTool.ts:101

Methods

execute

execute(_args, _context): Promise<ToolExecutionResult<MemoryConsolidationResult>>
Run one full consolidation cycle and return the statistics.

If a consolidation cycle is already in progress (mutex guard in ConsolidationLoop), run() returns immediately with zero counts — this is surfaced as a successful result with all-zero statistics.
Parameters
- _args: MemoryReflectInput
  Reflect input (optional topic hint, currently unused).
- _context: ToolExecutionContext
  Tool execution context (not used by this tool).
Returns Promise<ToolExecutionResult<MemoryConsolidationResult>>
ConsolidationResult on success, or an error result.
Implementation of ITool.execute
- Defined in src/memory/io/tools/MemoryReflectTool.ts:121

Properties

`Readonly` id

id: "memory-reflect-v1" = 'memory-reflect-v1'

Globally unique tool identifier.

`Readonly` name

name: "memory_reflect" = 'memory_reflect'

LLM-facing tool name.

`Readonly` displayName

displayName: "Reflect on Memory" = 'Reflect on Memory'

Human-readable display name.

`Readonly` description

description: string = ...

Description shown to the LLM. The consolidation steps are described explicitly so the model understands what "reflect" means operationally.

`Readonly` category

category: "memory" = 'memory'

Logical category for discovery and grouping.

`Readonly` hasSideEffects

hasSideEffects: true = true

Consolidation writes to the database (pruning, merging, inserting insights). Mark as having side effects so callers may request confirmation if needed.

`Readonly` inputSchema

inputSchema: JSONSchemaObject = ...

JSON schema for input validation and LLM tool-call construction.

Class MemoryReflectTool

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns MemoryReflectTool

Methods

execute

Parameters

Returns Promise<ToolExecutionResult<MemoryConsolidationResult>>

Properties

`Readonly` id

`Readonly` name

`Readonly` displayName

`Readonly` description

`Readonly` category

`Readonly` hasSideEffects

`Readonly` inputSchema

Settings

Member Visibility

Theme

On This Page

Class MemoryReflectTool

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns MemoryReflectTool

Methods

execute

Parameters

Returns Promise<ToolExecutionResult<MemoryConsolidationResult>>

Properties

Readonly id

Readonly name

Readonly displayName

Readonly description

Readonly category

Readonly hasSideEffects

Readonly inputSchema

Settings

Member Visibility

Theme

On This Page

`Readonly` id

`Readonly` name

`Readonly` displayName

`Readonly` description

`Readonly` category

`Readonly` hasSideEffects

`Readonly` inputSchema