Skip to main content
Glama

List batch recipients

list_batch_recipients
Read-onlyIdempotent

List a batch's recipients with each one's status.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "list_batch_recipients"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesBatch id
limitNoMax results (default 25, max 100)
cursorNonext_cursor from the previous page
statusNoOnly recipients with this status

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / status / description
      Added value: +"Only recipients with this status"
    • addedInput schema / properties / status / enum
      Added value: +[
      +  "queued",
      +  "paused",
      +  "sent",
      +  "failed",
      +  "skipped",
      +  "canceled"
      +]
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare this as read-only, idempotent, non-destructive, and closed-world. The description adds that results include recipient status, but it does not disclose pagination behavior, ordering, or other operational details beyond what the schema and annotations provide.

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?

A single front-loaded sentence with no wasted words. It states the resource and the returned status field immediately.

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?

For a simple read-only list tool with rich annotations and full schema coverage, the description is nearly sufficient. Its main gap is not differentiating itself from related batch and result tools, but it is complete enough to select and invoke correctly.

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 all four parameters are already documented, including the status enum. The description mentions recipient status but adds no meaning beyond the schema for id, limit, cursor, or filtering semantics.

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 uses a specific verb and resource: 'List a batch's recipients.' It clearly says what is returned, including each recipient's status, but it does not distinguish this tool from siblings like get_batch_results or list_batches.

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

Usage Guidelines2/5

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

The description gives no explicit guidance on when to use this tool, when not to use it, or which sibling to choose instead. Usage is only implied by the tool name and the phrase 'List a batch's recipients.'

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.