Skip to main content
Glama
Sign In
BoteX

BoteX

by kubainter
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

read_memory

Retrieve a memory entry's full content and metadata by ID from the Memory Vault, with optional workspace and local/global scope selection for targeted lookup.

Instructions

Reads the full content and metadata of a specific memory entry by ID from the Memory Vault.

Args:
    memory_id: The ID of the memory entry to retrieve (e.g. 'mem_a1b2c3d4').
    workspace_dir: Workspace root directory. Empty = engine.default_workspace
           from the config, else the server's current directory.
    scope: Lookup scope ('local', 'global', or 'all'). Default is 'local'.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "memory_id": "<memory_id>"
    },
    "name": "read_memory"
  }
}

Input Schema

NameRequiredDescriptionDefault
scopeNolocal
memory_idYes
workspace_dirNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.1.2
    • addedInput schema / properties / scope
      Added value: +{
+  "default": "local",
+  "title": "Scope",
+  "type": "string"
+}
  2. Changed1 schema field changedv1.1.1
    • changedInput schema / properties / workspace_dir / default
      Previous value: -"."New value: +""
  3. First observedv1.0.0

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden. It does disclose useful behavior: it returns full content plus metadata, and it spells out scope defaults ('local') and the workspace_dir fallback chain. It does not say whether the read is scoped across 'all' safely, what a miss returns, or any permission requirements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded one-sentence purpose followed by a compact Args block; no filler. Slightly redundant with schema titles, but each line adds semantics the schema lacks.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values needn't be described, and the description still frames the payload as content plus metadata. All three parameters are documented; only edge-case behavior (missing ID, cross-scope resolution) is left uncovered.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate, and it largely does: memory_id gets a concrete example format, workspace_dir explains the empty-string fallback to config default then cwd, and scope lists its three enum values with a default. Minor gap: how 'all' resolves conflicting local/global entries is unstated.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Reads the full content and metadata of a specific memory entry by ID') and names the storage system. The 'by ID' framing implicitly separates it from search_memory, though no sibling is named explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied rather than stated: retrieval by known ID versus discovery via search_memory is left for the agent to infer. There is no when-to-use/when-not-to-use guidance and no mention of what happens when the ID is unknown or the entry is absent.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools