Skip to main content
Glama

list_digest_instances

Read-only

List the digest instances for a digest schedule. Each instance is the events accumulated so far for one user against that schedule, so this shows what is waiting to go out and answers why a digest has not arrived yet — it is still accumulating, or it has nothing in it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum instances to return. Defaults to 20; the API caps this at 100.
cursorNoFor fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.
schedule_idYesThe digest schedule id, in the form "sch/{uuid}"

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / cursor / description
      Previous value: -"Pagination cursor from a previous response"New value: +"For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call."
    • changedInput schema / properties / limit / description
      Previous value: -"Max instances to return (default 20, max 100)"New value: +"Maximum instances to return. Defaults to 20; the API caps this at 100."
  2. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the read-only nature is covered. The description adds behavioral value by explaining that each instance represents per-user accumulated events and why a digest might be pending (still accumulating or empty). This goes beyond the annotation's basic safety hint and helps the agent interpret the results.

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?

The description is a single sentence but packs the core action, a definition of instances, and a diagnostic rationale without redundancy. It is front-loaded with the primary purpose and remains readable. While not overly concise, it uses structure well and contains no filler.

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?

There is no output schema, so the description must convey what to expect. It explains the nature of instances and the diagnostic value, which is largely sufficient for a list operation. It does not describe ordering or explicit pagination semantics, but the cursor parameter is already documented in the schema. Overall, the description covers the essential context.

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 100%, and the schema descriptions for limit, cursor, and schedule_id are already detailed (defaults, caps, format, and opaque-token warnings). The tool description does not add parameter-specific semantics beyond what the schema provides, so the baseline 3 applies.

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?

The description clearly states the verb (List), the resource (digest instances), and defines what an instance is ('events accumulated so far for one user against that schedule'). It also explains the purpose (shows what is waiting to go out, answers why a digest hasn't arrived). This is specific and distinguishes it from related tools like release_digest.

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?

The description gives clear context for when to use this tool: to inspect what is waiting to go out and diagnose non-arrival. It implicitly distinguishes from release tools by focusing on inspection. However, it does not explicitly name alternatives or state when not to use it, so it falls short of the 5-level criterion.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources