Skip to main content
Glama

list_batches

List the caller's bulk-verification batches, newest first, paginated with limit (default 20, cap 96) and offset, optionally narrowed by status, a part of the name (search) and a creation range (from, to), and sorted by created_at, name or total with order. Use it to find a batch_uuid or review recent bulk work; for single-address verifications use list_jobs instead, and for one batch's detail use get_batch. Requires the results:read scope.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

Input Schema

NameRequiredDescriptionDefault
toNoKeep only the batches created at or before this RFC 3339 time.
fromNoKeep only the batches created at or after this RFC 3339 time.
sortNoOrder by created_at (default), name, or total (the number of addresses).
limitNoNumber of batches to return (API default 20, cap 96).
orderNoOrder direction: desc (default) or asc.
offsetNoNumber of batches to skip (default 0).
searchNoKeep only the batches whose name contains this text, ignoring case.
statusNoKeep only the batches in one of these statuses: pending, validating, processing, paused, completed, partially_completed, failed, canceled.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • addedInput schema / properties / from
      Added value: +{
      +  "description": "Keep only the batches created at or after this RFC 3339 time.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedInput schema / properties / order
      Added value: +{
      +  "description": "Order direction: desc (default) or asc.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedInput schema / properties / search
      Added value: +{
      +  "description": "Keep only the batches whose name contains this text, ignoring case.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedInput schema / properties / sort
      Added value: +{
      +  "description": "Order by created_at (default), name, or total (the number of addresses).",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedInput schema / properties / status
      Added value: +{
      +  "description": "Keep only the batches in one of these statuses: pending, validating, processing, paused, completed, partially_completed, failed, canceled.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": [
      +    "array",
      +    "null"
      +  ]
      +}
    • addedInput schema / properties / to
      Added value: +{
      +  "description": "Keep only the batches created at or before this RFC 3339 time.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses the required 'results:read' scope, tenancy scoping ('caller's'), the pagination contract (default 20, cap 96, offset), and sort defaults. It does not state what fields each returned batch contains or whether pagination is cursor- vs offset-based beyond limit/offset, so it stops short of full disclosure.

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-loaded with the verb and resource, then pagination/filter mechanics, then routing to alternatives. The first sentence is dense with parentheticals, but every clause (cap, defaults, filter fields, sort keys) carries real information and nothing is redundant padding.

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 an 8-optional-parameter read tool with no annotations and no output schema, the definition covers auth scope, filtering surface, sorting, and pagination adequately. The main residual gap is that the agent is not told the shape of a returned batch record (uuid, name, status, total, timestamps), which the description only implies.

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 each parameter already has a precise description (RFC 3339 bounds, status enum values, sort/order semantics). The description largely restates those same facts (limit default 20/cap 96, sort by created_at/name/total, order) rather than adding new meaning, 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?

Specific verb+resource ('List the caller's bulk-verification batches') with scope ('caller's'), default ordering ('newest first'), and explicit differentiation from the two nearest siblings (list_jobs, get_batch). An agent can distinguish this from every sibling without opening a 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?

Gives concrete use cases ('find a batch_uuid or review recent bulk work') and names both alternatives with the condition that selects each: list_jobs for single-address verifications, get_batch for one batch's detail. This is the when/when-not/alternative pattern done properly.

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