Skip to main content
Glama

Get Reference

get_reference
Read-only

Read the Gramps Web MCP reference for valid argument formats, types, metadata, name settings, and filter rules before creating, updating, or listing family tree records.

Instructions

Read the server's reference for writing valid arguments; it holds no family records. Call it before a create_*, update_* or list_objects call when a date, name, link update, type or filter rule is unclear; to read the tree itself use search, list_objects or get_object. topic picks the text: input-guide (argument formats), types (valid types, with the tree's custom ones), metadata (server and tree info), name-settings (name formats, surname groups) or filter-rules (rules for list_objects, saved filters). section returns one part of a topic, e.g. topic types with section event_types; an unknown topic or section is rejected with the valid values. Returns input-guide as fixed JSON and the other topics as plain text read live from the tree. Clients that read MCP resources get the same texts at gramps://input-guide and its siblings.

Input Schema

NameRequiredDescriptionDefault
topicYesWhich reference: input-guide, types, metadata, name-settings or filter-rules.
sectionNoOne part only (optional; omit for the whole topic). input-guide: dates, name_schema, link_updates, structured_fields, or one of structured_fields.names, .attributes, .urls, .addresses, .person_associations, .repository_refs. types: a category such as event_types or place_types. name-settings: formats or groups. filter-rules: a type such as people or events (its rules and values; omit for an overview). metadata has no sections.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.6.0
    • changedInput schema / properties / section / description
      Previous value: -"One part only (optional; omit for the whole topic). input-guide: dates, name_schema, link_updates, structured_fields, or one of structured_fields.names, .attributes, .urls, .addresses, .person_associations, .repository_refs. types: a category such as event_types or place_types. name-settings: formats or groups. metadata has no sections."New value: +"One part only (optional; omit for the whole topic). input-guide: dates, name_schema, link_updates, structured_fields, or one of structured_fields.names, .attributes, .urls, .addresses, .person_associations, .repository_refs. types: a category such as event_types or place_types. name-settings: formats or groups. filter-rules: a type such as people or events (its rules and values; omit for an overview). metadata has no sections."
    • changedInput schema / properties / topic / description
      Previous value: -"Which reference: input-guide, types, metadata or name-settings."New value: +"Which reference: input-guide, types, metadata, name-settings or filter-rules."
  2. Changed2 schema fields changedv2.3.0
    • changedInput schema / properties / section / description
      Previous value: -"Optional section. input-guide: dates | name_schema | link_updates | structured_fields | structured_fields.names | structured_fields.attributes | structured_fields.urls | structured_fields.addresses | structured_fields.person_associations | structured_fields.repository_refs. types: a category key such as event_types. name-settings: formats | groups. Not supported for metadata."New value: +"One part only (optional; omit for the whole topic). input-guide: dates, name_schema, link_updates, structured_fields, or one of structured_fields.names, .attributes, .urls, .addresses, .person_associations, .repository_refs. types: a category such as event_types or place_types. name-settings: formats or groups. metadata has no sections."
    • changedInput schema / properties / topic / description
      Previous value: -"Reference topic: input-guide | types | metadata | name-settings."New value: +"Which reference: input-guide, types, metadata or name-settings."
  3. First observedv2.2.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnlyHint/destructiveHint/openWorldHint, so the bar is low, yet the description adds real value: it documents error behavior ('an unknown topic or section is rejected with the valid values'), return formats (input-guide as fixed JSON, other topics as plain text read live from the tree), and the MCP-resource mirror (gramps://input-guide). None of that is recoverable from the annotations.

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?

Front-loads purpose and the routing rule before the topic enumeration and return-format notes. It is dense and slightly run-on, but essentially every clause carries either usage routing or parameter semantics, so little is wasted.

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 correctly fills the gap by stating return formats per topic and the resource equivalent. Combined with the full parameter coverage and explicit alternatives, an agent has everything needed to invoke it 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 cross-parameter meaning beyond the schema: how topic and section interact ('section returns one part of a topic, e.g. topic types with section event_types') and the note that 'metadata has no sections'. This helps an agent compose valid combinations rather than repeating the schema.

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 ('Read the server's reference for writing valid arguments') and immediately scopes it ('it holds no family records'), distinguishing it from the tree-reading siblings. An agent can tell this is a documentation/reference lookup, not a data fetch.

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?

Gives explicit timing ('Call it before a create_*, update_* or list_objects call when a date, name, link update, type or filter rule is unclear') and names the correct alternatives for the opposite need ('to read the tree itself use search, list_objects or get_object'). When-to-use, when-not-to-use, and alternatives are all present.

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