Skip to main content
Glama

add_note

Attach a free-text note to any GEDCOM record, such as an individual, family, or source, to record additional research details or commentary.

Instructions

Attach a free-text note to a record.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesAny record id (@I..@, @F..@, @S..@)
fileNoGEDCOM file name (with or without .ged). Optional when only one file exists.
textYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoId of the record created or modified
fileYes
backupNoPath of the .bak written before saving
messageYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds nothing beyond that — it doesn't say whether the note is appended or replaces existing notes, nor anything about auth or scope constraints for a mutation tool.

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 clean sentence with the verb and object front-loaded and zero filler. It is efficient, though arguably terse for a mutation tool.

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?

An output schema exists and annotations carry the safety profile, so the description needn't explain returns. However, for a write operation with 3 parameters it omits any behavioral detail about what attaching a note actually does to the record, leaving it only minimally complete.

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 67%, so the schema documents the id pattern, the optional file argument, and the text field adequately. The description's phrase 'free-text note' loosely maps to the text parameter but adds no format, length, or target-type detail beyond the schema.

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?

The description states a specific verb (attach) and resource (free-text note) with a clear target (a record). No sibling tool offers note functionality, so differentiation is implicit rather than stated, but an agent can still tell exactly what this does.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no conditions, and no mention of alternatives among the numerous siblings (add_individual, update_individual, set_event, etc.). The usage context is left entirely to inference.

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