Skip to main content
Glama
ZenRows
by ZenRows

crawl_get

Read-only

Retrieve a crawl's status, coverage, and one page of kept URLs or results, then use next_cursor to paginate while it runs.

Instructions

Get a crawl and one page of the URLs it kept: crawl_id, status (running, completed, stopped, failed), the crawl (with coverage: pages_fetched, pages_failed, items_found), results and next_cursor.

completed with stop_reason max_items / max_pages means a limit ended it; stopped with stop_reason user means crawl_stop ended it; stopped with no stop_reason and error.code insufficient_credits or api_key_cap_reached means the account ran out of credits or the API key hit a credit cap (the URLs kept before that stay readable); completed with no results and no error means the crawl's pages held nothing new to follow; when include_patterns / exclude_patterns are set, check them against the URLs the start page links to. failed carries error.code and error.detail: seed_unreachable means the start URL could not be fetched or returned an empty page; no_items_found means the crawl read the start page but found no data it could use, so it had nothing to follow; start from a listing or product page. A failed crawl, and a stopped one with an error, answer ok: false: error.code is CRAWL_INSUFFICIENT_CREDITS or CRAWL_KEY_CAP_REACHED (the codes crawl_create gets on a 402) when credits ended it, failed or stopped, else CRAWL_FAILED; error.server_code is the crawl's error.code. Pass next_cursor as cursor for the next page; while the crawl runs, next_cursor is never null. To read many pages at once, use crawl_results.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoResults in this page (default 100, max 10000)
cursorNonext_cursor from a previous crawl_get call, to continue from there
crawl_idYesCrawl id returned by crawl_create (c_…)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.7.0

TDQS

A4.5/5.0
Behavior5/5

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

Goes well beyond the readOnly/openWorld annotations by decoding every status (running/completed/stopped/failed), the meaning of each stop_reason, credit-exhaustion cases, empty-result semantics, and the ok:false error codes. This is the behavioral context an agent needs and cannot get from the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The first sentence front-loads the purpose well, but the remainder is a dense run-on block mixing statuses, stop_reasons, and error codes without bullets or headings, which hurts scannability. It is informative but over-packed rather than tight.

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?

With no output schema, the description carries the full burden and does so thoroughly: it details the returned fields, every status/stop_reason combination, error-code semantics, and pagination behavior. An agent has everything needed to call and interpret it.

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

Parameters4/5

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

Schema coverage is 100% so the baseline is 3, and the description adds the key relational detail that next_cursor from a prior call is passed as cursor and that next_cursor is never null while a crawl runs. It does not elaborate on the limit parameter beyond the schema's default/max.

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?

States a specific verb+resource (get a crawl plus one page of kept URLs) and enumerates the returned fields (crawl_id, status, coverage, results, next_cursor). It explicitly differentiates itself from the sibling crawl_results for multi-page reads.

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?

Names the alternative crawl_results and the condition that selects it ('to read many pages at once'), and explains how to continue paging via next_cursor/cursor. It does not, however, distinguish itself from crawl_wait or crawl_list, so sibling routing is not fully covered.

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