Skip to main content

Class: MemoryDeleteTool

Defined in: packages/agentos/src/memory/tools/MemoryDeleteTool.ts:62

ITool implementation that soft-deletes a memory trace from the agent's SQLite brain database.

Usage:

const tool = new MemoryDeleteTool(brain);
const result = await tool.execute(
  { traceId: 'mt_1711234567890_0', reason: 'Information is outdated.' },
  context,
);
// result.output.deleted → true

Implements​

  • ITool<MemoryDeleteInput, MemoryDeleteOutput>

Constructors​

Constructor​

new MemoryDeleteTool(brain): MemoryDeleteTool

Defined in: packages/agentos/src/memory/tools/MemoryDeleteTool.ts:103

Parameters​

brain​

SqliteBrain

The agent's shared SQLite brain database connection.

Returns​

MemoryDeleteTool

Properties​

category​

readonly category: "memory" = 'memory'

Defined in: packages/agentos/src/memory/tools/MemoryDeleteTool.ts:79

Logical category for discovery and grouping.

Implementation of​

ITool.category

description​

readonly description: string

Defined in: packages/agentos/src/memory/tools/MemoryDeleteTool.ts:73

LLM-facing description.

Implementation of​

ITool.description

displayName​

readonly displayName: "Delete Memory" = 'Delete Memory'

Defined in: packages/agentos/src/memory/tools/MemoryDeleteTool.ts:70

Human-readable display name.

Implementation of​

ITool.displayName

hasSideEffects​

readonly hasSideEffects: true = true

Defined in: packages/agentos/src/memory/tools/MemoryDeleteTool.ts:82

This tool writes to the database.

Implementation of​

ITool.hasSideEffects

id​

readonly id: "memory-delete-v1" = 'memory-delete-v1'

Defined in: packages/agentos/src/memory/tools/MemoryDeleteTool.ts:64

Globally unique tool identifier.

Implementation of​

ITool.id

inputSchema​

readonly inputSchema: JSONSchemaObject

Defined in: packages/agentos/src/memory/tools/MemoryDeleteTool.ts:85

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

Implementation of​

ITool.inputSchema

name​

readonly name: "memory_delete" = 'memory_delete'

Defined in: packages/agentos/src/memory/tools/MemoryDeleteTool.ts:67

LLM-facing tool name.

Implementation of​

ITool.name

Methods​

execute()​

execute(args, _context): Promise<ToolExecutionResult<MemoryDeleteOutput>>

Defined in: packages/agentos/src/memory/tools/MemoryDeleteTool.ts:120

Set deleted = 1 on the memory trace matching traceId.

The WHERE clause filters to deleted = 0 so that attempting to delete an already-deleted trace returns { deleted: false } rather than silently succeeding — this gives callers accurate feedback.

Parameters​

args​

MemoryDeleteInput

Delete input (traceId, optional reason).

_context​

ToolExecutionContext

Tool execution context (not used by this tool).

Returns​

Promise<ToolExecutionResult<MemoryDeleteOutput>>

{ deleted } status, or an error result.

Implementation of​

ITool.execute