Skip to main content

Class: ReadWorkingMemoryTool

Defined in: packages/agentos/src/cognition/memory/core/working/ReadWorkingMemoryTool.ts:15

Tool that lets the agent explicitly read its persistent working memory. The memory is also injected into the system prompt automatically, but this tool is useful when the agent wants to reason about its memory before deciding what to update.

Implements​

  • ITool<Record<string, never>, ReadOutput>

Constructors​

Constructor​

new ReadWorkingMemoryTool(memory): ReadWorkingMemoryTool

Defined in: packages/agentos/src/cognition/memory/core/working/ReadWorkingMemoryTool.ts:30

Parameters​

memory​

MarkdownWorkingMemory

Returns​

ReadWorkingMemoryTool

Properties​

category​

readonly category: "memory" = 'memory'

Defined in: packages/agentos/src/cognition/memory/core/working/ReadWorkingMemoryTool.ts:23

Optional

Optional. A category or group to which this tool belongs (e.g., "data_analysis", "communication", "file_system", "image_generation"). This is useful for organizing tools, for filtering in UIs or registries, and potentially for aiding an LLM in selecting from a large set of tools.

Implementation of​

ITool.category

description​

readonly description: string

Defined in: packages/agentos/src/cognition/memory/core/working/ReadWorkingMemoryTool.ts:19

A detailed, natural language description of what the tool does, its primary purpose, typical use cases, and any important considerations or limitations for its use. This description is critical for an LLM to understand the tool's capabilities and make informed decisions about when and how to invoke it. It should be comprehensive enough for the LLM to grasp the tool's semantics.

Implementation of​

ITool.description

displayName​

readonly displayName: "Read Working Memory" = 'Read Working Memory'

Defined in: packages/agentos/src/cognition/memory/core/working/ReadWorkingMemoryTool.ts:18

A concise, human-readable title or display name for the tool. Used in user interfaces, logs, or when presenting tool options to developers or users.

Example​

"Web Search Engine", "Advanced Python Code Interpreter"

Implementation of​

ITool.displayName

hasSideEffects​

readonly hasSideEffects: false = false

Defined in: packages/agentos/src/cognition/memory/core/working/ReadWorkingMemoryTool.ts:24

Optional

Optional. Indicates if the tool might have side effects on external systems (e.g., writing to a database, sending an email, making a purchase, modifying a file). Defaults to false if not specified. LLMs or orchestrators might handle tools with side effects with greater caution, potentially requiring explicit user confirmation.

Implementation of​

ITool.hasSideEffects

id​

readonly id: "read-working-memory-v1" = 'read-working-memory-v1'

Defined in: packages/agentos/src/cognition/memory/core/working/ReadWorkingMemoryTool.ts:16

A globally unique identifier for this specific tool (e.g., "web-search-engine-v1.2", "stock-price-fetcher"). This ID is used for internal registration, management, and precise identification. It's recommended to use a namespaced, versioned format (e.g., vendor-toolname-version).

Implementation of​

ITool.id

inputSchema​

readonly inputSchema: JSONSchemaObject

Defined in: packages/agentos/src/cognition/memory/core/working/ReadWorkingMemoryTool.ts:25

The JSON schema defining the structure, types, and constraints of the input arguments object that this tool expects. This schema is used by:

  1. LLMs: To construct valid argument objects when requesting a tool call.
  2. ToolExecutor: For validating the arguments before invoking the tool's execute method. It should follow the JSON Schema specification.

See​

https://json-schema.org/

Implementation of​

ITool.inputSchema

name​

readonly name: "read_working_memory" = 'read_working_memory'

Defined in: packages/agentos/src/cognition/memory/core/working/ReadWorkingMemoryTool.ts:17

The functional name of the tool, as it should be presented to and used by an LLM in a tool call request (e.g., "searchWeb", "executePythonCode", "getWeatherForecast"). This name must be unique among the set of tools made available to a given GMI/LLM at any time. It should be concise, descriptive, and typically in camelCase or snake_case.

Implementation of​

ITool.name

Methods​

execute()​

execute(_args, _context): Promise<ToolExecutionResult<ReadOutput>>

Defined in: packages/agentos/src/cognition/memory/core/working/ReadWorkingMemoryTool.ts:32

Async

Executes the core logic of the tool with the provided arguments and execution context. This method is asynchronous and should encapsulate the tool's primary functionality. Implementations should handle their own internal errors gracefully and package them into the ToolExecutionResult object.

Parameters​

_args​

Record<string, never>

_context​

ToolExecutionContext

Returns​

Promise<ToolExecutionResult<ReadOutput>>

A promise that resolves with a ToolExecutionResult object, which contains the success status, the output data (if successful), or an error message (if failed).

Throws​

While tools should ideally capture errors and return them in ToolExecutionResult.error, critical, unrecoverable, or unexpected system-level failures during execution might still result in a thrown exception. The ToolExecutor should be prepared to catch these.

Implementation of​

ITool.execute