Skip to main content
Glama
ianderso
by ianderso

update_object_fields

DestructiveIdempotent

Set scalar fields on any Gramps object, such as a place name or note text. Use it for simple edits on places, notes, and repositories; structural lists need dedicated tools.

Instructions

Set scalar fields on any object -- the escape hatch for places, notes, repositories and the rest.

Only scalar fields are settable. Structural lists (citation_list, event_ref_list, media_list, ...) are refused on purpose: replacing one wholesale is exactly how references get silently dropped. Each has its own tool -- cite_object, detach_object, tag_object, attach_media.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
refYesHandle or gramps_id.
fieldsYesScalar fields to set, e.g. {'name': 'Cedar Flat, Brannock, Ohio, USA'} on a place, or {'text': '...'} on a note.
object_typeYesType of object to edit.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the write/idempotent profile is covered. The description adds genuine context beyond them: scalar-only scope and the rationale that wholesale list replacement silently drops references. It stops short of noting permission needs or error behavior for invalid field names.

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?

Four short sentences, purpose front-loaded, then the constraint, its rationale, and the alternatives. Every sentence carries distinct information with no repetition of schema or annotation content.

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?

With no output schema and a deliberately generic three-parameter signature, the definition covers what it does, its key restriction, and where to go instead. Missing only edge details such as failure modes on unknown field names or required permissions, which are minor for this tool.

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 100%, so the baseline is 3. The description earns above that by constraining the otherwise open 'fields' object to scalar values and giving concrete examples (name on a place, text on a note), clarifying semantics the schema alone leaves ambiguous.

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: 'Set scalar fields on any object', plus the framing 'escape hatch for places, notes, repositories'. It also distinguishes itself from the structural-list siblings by name, so an agent can tell it apart without opening another 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?

Explicitly says what is not settable (structural lists) and routes those cases to cite_object, detach_object, tag_object and attach_media. It does not, however, state when to prefer the typed siblings (update_place, update_person, update_source) over this generic escape hatch, so the when-to-use side is only partly covered.

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