Skip to main content
Glama

memory_record_episode

Record engineering decisions, root causes, incidents, and session notes as immutable episodes linked to affected files and referenced entities for persistent project memory.

Instructions

Record an immutable engineering episode (ADR, bug_root_cause, invariant, session_note, migration, incident) with associated files and mentioned entities.

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": {
      "title": "<title>",
      "category": "<category>",
      "content": "<content>"
    },
    "name": "memory_record_episode"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleYesShort descriptive title of the episode.
contentYesDetailed architectural or technical note.
categoryYesEpisode classification category.
timestampNoOptional ISO-8601 UTC timestamp.
files_touchedNoRelative repository file paths involved.
entities_mentionedNoCanonical entity IDs referenced in this episode.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.4/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 and does disclose the most important trait: episodes are immutable, implying corrections require a new record rather than an edit. It omits other relevant behavior for a write tool — whether it is idempotent, how duplicates are handled, whether timestamp defaults to now, and whether it requires workspace or auth context.

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?

A single front-loaded sentence with the verb and the key immutability property first, and the parenthetical category list is compact and informative. Slight density in the parenthetical, but no wasted sentences.

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

Completeness3/5

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

For a six-parameter write tool with no annotations and no output schema, the definition covers what to record but not what comes back (e.g., an episode identifier to reference later) or idempotency expectations. Adequate but leaves real gaps for a mutation tool.

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

Parameters3/5

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

Schema coverage is 100%, so every one of the six parameters is already documented, including the category enum and the ISO-8601 timestamp format. The description only restates 'associated files and mentioned entities', adding no new meaning beyond the schema, so baseline 3 applies.

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 ('Record an immutable engineering episode') and enumerates the allowed categories, which lets an agent distinguish it from memory_upsert_fact (mutable facts) at a glance. It stops short of naming siblings explicitly, so the differentiation is inferential rather than stated.

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 only implied: 'immutable' hints that this is not the tool for facts you may later revise, and the category list hints at what qualifies. There is no explicit when-to-use, when-not-to-use, or named alternative such as memory_upsert_fact or memory_time_travel.

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