Skip to main content
Glama
Scormave

Gramps Web MCP

by Scormave
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Hybrid

List Objects

list_objects
Read-only

List records of one type by page with optional filters, sorting, or a single Gramps ID. Use it to browse, find citations, or query fields.

Instructions

List the records of one type, a page at a time, optionally filtered and sorted: one line per record (Gramps ID, summary, handle) with the page and total count. Use it to browse a type, look up one Gramps ID, list the citations of a source, or filter by fields with Gramps Query Language; to find records by text use search, and to read one record in full use get_object.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
gqlNoFilter in Gramps Query Language, run on the server, e.g. gender == 1 or media_list.length >= 1 (optional).
pageNoPage number, from 1 (default 1).
sortNoField to sort by, e.g. gramps_id; a leading - sorts descending, e.g. -change for latest edits first (optional).
grampsIdNoOnly the record with this Gramps ID, e.g. I0001 (not a handle; optional).
pagesizeNoRecords per page, 1–100 (default 20).
objectTypeYesWhich records to list: people, families, events, places, sources, citations, repositories, notes, media or tags.
sourceHandleNoWith objectType citations only: list just the citations of this source; combined with gql by and (optional). Handle or Gramps ID (e.g. I0001), resolved automatically; find it with search or list_objects.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv2.3.0
    • changedInput schema / properties / gql / description
      Previous value: -"Optional. Gramps QL expression executed server-side for filtering."New value: +"Filter in Gramps Query Language, run on the server, e.g. gender == 1 or media_list.length >= 1 (optional)."
    • changedInput schema / properties / grampsId / description
      Previous value: -"Optional. Filter by numeric/string Gramps ID (I0001-style), NOT the opaque handle."New value: +"Only the record with this Gramps ID, e.g. I0001 (not a handle; optional)."
    • changedInput schema / properties / objectType / description
      Previous value: -"Object collection: people | families | events | places | sources | citations | repositories | notes | media | tags (exact spelling, case-insensitive)."New value: +"Which records to list: people, families, events, places, sources, citations, repositories, notes, media or tags."
    • changedInput schema / properties / page / description
      Previous value: -"1-based page. Default 1."New value: +"Page number, from 1 (default 1)."
    • changedInput schema / properties / pagesize / description
      Previous value: -"Page size. Default 20, max 100."New value: +"Records per page, 1–100 (default 20)."
    • changedInput schema / properties / sort / description
      Previous value: -"Optional. Sort field; leading - means descending."New value: +"Field to sort by, e.g. gramps_id; a leading - sorts descending, e.g. -change for latest edits first (optional)."
    • changedInput schema / properties / sourceHandle / description
      Previous value: -"Optional. When objectType is citations, limit to citations of this source handle. Handle or Gramps ID (e.g. I0001). Handles are opaque strings from the API. Gramps IDs (like I0001, F0023) are auto-resolved to handles. Find handles with search() or list_objects()."New value: +"With objectType citations only: list just the citations of this source; combined with gql by and (optional). Handle or Gramps ID (e.g. I0001), resolved automatically; find it with search or list_objects."
  2. First observedv2.2.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds genuinely useful behavior: results are one line per record (Gramps ID, summary, handle) with page and total count, and it discloses pagination semantics. It does not discuss error behavior or server-side GQL limits, so not a 5.

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 dense paragraph that front-loads the core action and output shape before the usage routing. Every clause carries information, though the sentence is long and slightly run-on; it is compact rather than bloated.

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?

Given seven parameters, no output schema, and a large sibling set, the description covers purpose, output format, pagination, usage scenarios, and alternative routing. Nothing an agent needs to call it correctly is missing.

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 description coverage is 100%, so the schema already documents all seven parameters with examples (GQL syntax, sort direction, pagesize range, sourceHandle usage). The description alludes to filtering/sorting/pagination and singles out the citation-listing use case but adds no format detail beyond the schema, so baseline 3 is appropriate.

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 (List) and resource (records of one type) plus scope (paginated, filtered, sorted). It names the siblings it is not (search for text retrieval, get_object for full-record reads), so an agent can distinguish it without opening either schema.

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?

Enumerates concrete use cases: browse a type, look up one Gramps ID, list citations of a source, filter with GQL. Explicitly routes to alternatives with conditions ('to find records by text use search', 'to read one record in full use get_object').

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

Deploy Server

Other Tools