Skip to main content
Glama

record_fix

Records a confirmed fix and closes the related or active issue once tests pass or the user confirms, updating project memory.

Instructions

Record a confirmed fix and close an issue.

Only call AFTER you have evidence the fix works: test passes, error is gone,
or the user confirmed.

If `issue_id` is provided, the fix is attached to that specific issue.
If `issue_id` is omitted, the active issue is closed.

Side effects: appends a `fix` event and updates summary.md. The active-issue
marker is cleared only when the active issue is the issue being fixed.

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": {
      "summary": "<summary>"
    },
    "name": "record_fix"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectNoWhich project this call is about — a registered id, alias, or absolute path (e.g. 'ossdrop'). Omit it when the server was started for a single repo, or when an active project is set with `pjm project use`. Call list_projects to see the registered names.
summaryYesOne-line description of the confirmed fix (e.g., 'guarded submit handler with isSubmitting ref'). Keep it under 300 characters.
issue_idNoOptional zero-padded issue ID (e.g., '0042') to close. When omitted, closes the active issue. Numeric strings without padding are accepted.
locationNoOptional file path or component where the fix was applied.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.5
    • changedInput schema / properties / summary / description
      Previous value: -"One-line description of the confirmed fix (e.g., 'guarded submit handler with isSubmitting ref')."New value: +"One-line description of the confirmed fix (e.g., 'guarded submit handler with isSubmitting ref'). Keep it under 300 characters."
  2. Changed1 schema field changedv0.3.2
    • addedInput schema / properties / project
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Which project this call is about — a registered id, alias, or absolute path (e.g. 'ossdrop'). Omit it when the server was started for a single repo, or when an active project is set with `pjm project use`. Call list_projects to see the registered names.",
      +  "title": "Project"
      +}
  3. Changed1 schema field changedv0.1.5
    • addedInput schema / properties / issue_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Optional zero-padded issue ID (e.g., '0042') to close. When omitted, closes the active issue. Numeric strings without padding are accepted.",
      +  "title": "Issue Id"
      +}
  4. Changed2 schema fields changedv0.1.3
    • addedInput schema / properties / location / description
      Added value: +"Optional file path or component where the fix was applied."
    • addedInput schema / properties / summary / description
      Added value: +"One-line description of the confirmed fix (e.g., 'guarded submit handler with isSubmitting ref')."
  5. First observedv0.1.1

TDQS

A4.5/5.0
Behavior4/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 so well by naming side effects: appends a `fix` event, updates summary.md, and conditionally clears the active-issue marker. It stops short of stating idempotency, whether re-recording a fix duplicates events, 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.

Conciseness5/5

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

Front-loaded with purpose, then precondition, then parameter branching, then side effects. Four short blocks with no redundant restatement of the title or schema.

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

Completeness5/5

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

For a mutation tool with no annotations, the description covers purpose, gating precondition, per-parameter behavior, and side effects; return values are covered by the existing output schema. An agent has everything needed to decide and invoke correctly.

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 coverage is 100%, so baseline is 3, but the description adds real behavioral meaning: issue_id present means the fix attaches to that issue, absent means the active issue is closed. That conditional semantics goes beyond the schema's plain 'optional zero-padded issue ID' text.

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

Purpose5/5

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

States a specific verb and resource pair ('Record a confirmed fix and close an issue') and immediately clarifies the two modes of operation based on issue_id. An agent can distinguish this from log_issue or record_attempt without opening the schema.

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

Usage Guidelines4/5

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

Provides an explicit precondition gate: 'Only call AFTER you have evidence the fix works' with three concrete qualifying conditions (test passes, error gone, user confirmed). It does not name sibling alternatives such as record_attempt for unverified attempts, so the routing is implied rather than exhaustive.

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