Skip to main content
Glama

record_gotcha

Record a newly discovered pitfall into the project's memory so later agent sessions recall it. Optionally replace an outdated gotcha by its recalled id, and omit project to target the current repo.

Instructions

Record a pitfall just discovered into the project's memory so later sessions see it; replaces takes the id of a recalled gotcha it corrects. Omit project for the current repo.

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": {
      "text": "<text>"
    },
    "name": "record_gotcha"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYesWhat to remember, as one concrete sentence.
projectNoProject path; omit for the current repo.
replacesNoId of a recalled fact this one reverses or replaces; that one becomes history.
rationaleNoFor a decision: why it was made.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.11.4
    • addedInput schema / properties / replaces
      Added value: +{
      +  "description": "Id of a recalled fact this one reverses or replaces; that one becomes history.",
      +  "format": "int64",
      +  "type": [
      +    "integer",
      +    "null"
      +  ]
      +}
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "anyOf": [
      +    {
      +      "properties": {
      +        "id": {
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        },
      +        "kind": {
      +          "type": "string"
      +        },
      +        "message": {
      +          "type": "string"
      +        },
      +        "project": {
      +          "type": "string"
      +        },
      +        "replaces": {
      +          "properties": {
      +            "id": {
      +              "type": "integer"
      +            },
      +            "reason": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "result": {
      +              "oneOf": [
      +                {
      +                  "const": "replaced",
      +                  "type": "string"
      +                },
      +                {
      +                  "const": "disputed",
      +                  "type": "string"
      +                },
      +                {
      +                  "const": "rejected",
      +                  "type": "string"
      +                }
      +              ]
      +            }
      +          },
      +          "required": [
      +            "id",
      +            "result"
      +          ],
      +          "type": [
      +            "object",
      +            "null"
      +          ]
      +        }
      +      },
      +      "required": [
      +        "kind",
      +        "project",
      +        "message"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "properties": {
      +        "notice": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "notice"
      +      ],
      +      "type": "object"
      +    }
      +  ],
      +  "type": "object"
      +}
  2. Changed5 schema fields changedv0.11.3
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • changedInput schema / properties / project / description
      Previous value: -"Project-path substring to attach it to; omit to use the repo the server runs in."New value: +"Project path; omit for the current repo."
    • changedInput schema / properties / rationale / description
      Previous value: -"For a decision, WHY it was made (the rationale). Surfaced by check_decision later."New value: +"For a decision: why it was made."
    • changedInput schema / properties / text / description
      Previous value: -"What to remember (one concrete sentence)."New value: +"What to remember, as one concrete sentence."
    • removedInput schema / title
      Removed value: -"RememberArgs"
  3. Changed1 schema field changedv0.6.2
    • addedInput schema / properties / rationale
      Added value: +{
      +  "description": "For a decision, WHY it was made (the rationale). Surfaced by check_decision later.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  4. Addedv0.6.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare this is a non-readonly, non-destructive, non-idempotent write. The description adds real context beyond them: the write persists into shared project memory visible to future sessions, and `replaces` demotes the prior entry to history. It does not cover duplicate handling, whether repeated identical writes are safe given idempotentHint=false, or any failure modes.

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?

One tight sentence plus a clarifying clause; the core action is front-loaded and no sentence is wasted. The semicolon-joined `replaces` note is dense but readable.

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 need not be explained, and all four parameters are covered. What remains thin is routing among the recording siblings (record_decision, flag_fact) and write-conflict behaviour, but for this complexity the definition is largely sufficient.

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 both optional fields are already documented in the schema, including the 'becomes history' consequence of `replaces` and the 'omit for current repo' default. The description restates rather than extends that, meeting the baseline but adding no new syntax or format detail.

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 a pitfall') plus the destination ('into the project's memory') and the payoff ('so later sessions see it'). It conceptually separates a pitfall from a decision, but never names the near-neighbours record_decision or flag_fact, so the agent must infer the boundary.

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?

The trigger condition is implied by 'just discovered' and the correction path is spelled out via `replaces`. There is no explicit when-not guidance and no named alternative for cases where the item is a decision rather than a pitfall.

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