Skip to main content
Glama

Delete Object

delete_object
Destructive

Permanently delete one confirmed Gramps Web record; if other records link to it, deletion is blocked unless force=true is confirmed.

Instructions

Permanently delete one record; it cannot be undone through this server. Call it only after the user confirmed this exact record. If other records still point to it, nothing is deleted and the reply lists those backlinks by type; unlink them first with the owners' update tools, or pass force=true after a separate confirmation. On success returns the type, action: deleted and the handle; a missing record returns a not-found message.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
forceNotrue deletes even when other records still point to it, leaving those links dangling (default false).
handleYesThe record to delete. Handle or Gramps ID (e.g. I0001), resolved automatically; find it with search or list_objects.
objectTypeYesRecord type: person, family, event, place, source, citation, note, media, repository or tag.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.3.0
    • changedInput schema / properties / force / description
      Previous value: -"If true, delete despite backlinks. This may leave dangling references. Default false."New value: +"true deletes even when other records still point to it, leaving those links dangling (default false)."
    • changedInput schema / properties / handle / description
      Previous value: -"Object handle or Gramps ID (for example I0001). Handles are opaque API strings; Gramps IDs are resolved automatically."New value: +"The record to delete. Handle or Gramps ID (e.g. I0001), resolved automatically; find it with search or list_objects."
    • changedInput schema / properties / objectType / description
      Previous value: -"Object type: person | family | event | place | source | citation | note | media | repository | tag."New value: +"Record type: person, family, event, place, source, citation, note, media, repository or tag."
  2. First observedv2.2.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true, but the description goes further: deletion is permanent and not undoable via this server, backlinked records block deletion and are returned grouped by type, force leaves dangling links, and it describes both the success payload (type, action: deleted, handle) and the not-found case.

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 dense sentences, front-loaded with the destructive/permanent nature and the confirmation precondition, then failure mode, then return behavior. No filler or repetition of the tool name.

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?

With no output schema, the description supplies the return contract (type, action: deleted, handle; not-found message), the failure path, and the required user confirmation. An agent has everything needed to invoke it safely.

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 the baseline would be 3; however the description adds a genuine parameter-specific rule not present in the schema — force=true requires a separate confirmation and produces dangling links. That meaningfully enriches the force parameter beyond its schema 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 ('Permanently delete one record') plus scope ('one record') and irreversibility. It is immediately distinguishable from the many create_*/update_* siblings and from non-destructive readers like get_object.

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

Usage Guidelines5/5

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

Explicit preconditions: call only after the user confirmed this exact record; if backlinks exist, unlink them first with the owners' update tools; force=true requires a separate confirmation. This covers when to use it, when it will fail, and the alternative path.

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