Skip to main content
Glama

list_families

Retrieve families from a Kanka campaign with pagination and optional entry filtering to keep responses small and target empty or filled records.

Instructions

List families. Use per_page to keep responses small enough to be returned whole, and entry_filter to return only records whose entry is empty or filled.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (default 1).
entriesNoInclude full entry/entry_parsed text (default true). Set false to omit the long entry fields, shrink the response, and get a has_entry boolean per record instead.
per_pageNoRecords per page, 1-100. Enforced by this server, so it holds even when the Kanka API returns a different page size. Omit to return the API's own page untouched; when set (or when entry_filter is used) the default is 25 with entries, 100 without.
campaignIdYes
entry_filterNoKeep only records with an empty entry ('empty'), only records with text ('filled'), or all of them ('all', default). Filtering is applied across the whole collection, not just one API page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.2.0
    • addedInput schema / properties / entries
      Added value: +{
      +  "description": "Include full entry/entry_parsed text (default true). Set false to omit the long entry fields, shrink the response, and get a has_entry boolean per record instead.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / entry_filter
      Added value: +{
      +  "description": "Keep only records with an empty entry ('empty'), only records with text ('filled'), or all of them ('all', default). Filtering is applied across the whole collection, not just one API page.",
      +  "enum": [
      +    "all",
      +    "empty",
      +    "filled"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / page / description
      Added value: +"Page number (default 1)."
    • addedInput schema / properties / per_page
      Added value: +{
      +  "description": "Records per page, 1-100. Enforced by this server, so it holds even when the Kanka API returns a different page size. Omit to return the API's own page untouched; when set (or when entry_filter is used) the default is 25 with entries, 100 without.",
      +  "maximum": 100,
      +  "minimum": 1,
      +  "type": "number"
      +}
  2. First observedv2.1.1

TDQS

B3.4/5.0
Behavior2/5

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

With no annotations, the description bears the full disclosure burden, and it omits key traits: it never says the call is read-only, that campaignId is mandatory, whether responses are paginated (and how to detect the last page), or what the records contain. It hints that responses can be large and that per_page/entry_filter mitigate that, which is the only behavioral value added.

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?

Two short sentences, front-loaded with the operation and then the tuning knobs; no filler. Slight deduction because the second sentence packs two unrelated concerns (response size and filtering) without signaling the required campaignId.

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 five parameters with four richly described in the schema, no nested objects, and no output schema to explain, the description covers the operation and the two knobs an agent would actually reason about. The remaining gap (return shape) is minor for a simple list endpoint.

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 80%, so the schema already documents page, entries, per_page, and entry_filter in detail; the description only restates per_page and entry_filter at a higher level. It adds a small amount of intent (why to shrink responses) but no syntax, defaults, or limits beyond what the schema supplies, so baseline 3 applies.

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 opens with a specific verb+resource ("List families"), which cleanly separates it from get_family/create_family/update_family siblings. It stops short of naming those siblings or stating the campaign scope, but the operation itself is unambiguous.

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

Usage Guidelines3/5

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

The description explains how to use two optional parameters (per_page for smaller responses, entry_filter to narrow records), which implies usage context. However, it never states when to reach for this tool versus get_family or search, and gives no exclusions or prerequisites such as the required campaignId.

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