Skip to main content
Glama
ZenRows
by ZenRows

batch_list

Read-only

List account Batch jobs newest first with latest run status and stats, filter by status or type, and page with next_cursor until null.

Instructions

List this account's Batch jobs, newest first, each with its latest run's status and stats. Filter by status (open or closed) and type (regular or scheduled). Pass next_cursor as cursor for the next page; a page can hold fewer than limit jobs while next_cursor is still set, so keep paging until it is null. Deleted jobs are not listed.

Input Schema

NameRequiredDescriptionDefault
typeNoOnly jobs of this type
limitNoJobs per page (default 20, max 100)
cursorNonext_cursor from a previous batch_list call
statusNoOnly jobs with this job status

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.15.1

TDQS

A5/5.0
Behavior5/5

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

The description adds significant behavioral traits beyond the read-only annotation. It specifies the sorting order ('newest first'), the data provided ('latest run's status and stats'), and crucial negative constraints ('Deleted jobs are not listed').

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?

The description is highly dense and efficient. It front-loads the core function and uses every clause to communicate a critical operational or structural requirement (sorting, filtering, paging).

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?

The definition is comprehensive. It covers the scope (this account), the required output details (stats/status), the filtering mechanism, and the full pagination lifecycle, leaving no operational requirements ambiguous.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

While schema coverage is 100%, the description provides deep functional semantics for the parameters. Specifically, it details that `next_cursor` facilitates pagination and explains the practical constraint of when to stop iterating, adding context beyond the schema definition.

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 purpose is stated clearly and specifically: 'List this account's Batch jobs.' It effectively distinguishes itself from sibling tools like `batch_create` or `batch_cancel` by focusing exclusively on retrieval.

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?

Usage guidelines are exceptional. The description details the specific filtering capabilities (status/type) and, crucially, outlines the precise pagination logic, advising the agent to 'keep paging until it is null.'

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