Skip to main content
Glama

Check a batch job's status

spicrawl_batch_status
Read-onlyIdempotent

Return one batch job with its status and progress (total/completed/succeeded/failed/remaining, credits charged). Poll this after spicrawl_batch_submit; once status is completed, failed or cancelled, read spicrawl_batch_results.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
job_idYesThe batch job id returned by spicrawl_batch_submit or spicrawl_batch_list.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesJob id. Pass it as `job_id` to the other spicrawl_batch_* tools.
nameNoThe label given at submission, if any.
openNoTrue while the job accepts appended items (it will not complete until closed).
paramsNoThe job-level scrape settings as stored.
statusNoLifecycle: queued, running, paused, cancelling, completed, failed or cancelled. Keep polling while queued/running/paused/cancelling; stop at completed, failed or cancelled.
priorityNoEffective scheduling priority.
progressNoLive item counters and the credits charged so far.
warningsNoDecisions made on the caller's behalf at submission (a clamped concurrency, items not yet queued).
error_codeNoMachine code of a job-level failure.
project_idNoProject the API key belongs to.
started_atNoISO-8601 time the first item started.
status_urlNoAPI path to poll for this job: /v1/batch/{id}.
concurrencyNoEffective per-job concurrency after the server's clamping.
finished_atNoISO-8601 time the job reached a terminal status.
results_urlNoAPI path of the job's results: /v1/batch/{id}/results.
total_itemsNoNumber of items in the job.
max_attemptsNoEffective attempts per item.
submitted_atNoISO-8601 time the job was accepted.
error_messageNoHuman-readable job-level failure reason.
estimated_creditsNoCredits reserved at submission (a hold, not a charge; compare with progress.credits_charged).
failure_thresholdNoFailed-item count that aborts the job, when set.
results_expire_atNoISO-8601 deadline after which results answer 410 Gone.
cancel_requested_atNoISO-8601 time a cancel was accepted.
estimated_credits_microNoSame as estimated_credits in micro-credits.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": true,
      +  "properties": {
      +    "cancel_requested_at": {
      +      "description": "ISO-8601 time a cancel was accepted.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "concurrency": {
      +      "description": "Effective per-job concurrency after the server's clamping.",
      +      "type": "number"
      +    },
      +    "error_code": {
      +      "description": "Machine code of a job-level failure.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "error_message": {
      +      "description": "Human-readable job-level failure reason.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "estimated_credits": {
      +      "description": "Credits reserved at submission (a hold, not a charge; compare with progress.credits_charged).",
      +      "type": "number"
      +    },
      +    "estimated_credits_micro": {
      +      "description": "Same as estimated_credits in micro-credits.",
      +      "type": "number"
      +    },
      +    "failure_threshold": {
      +      "description": "Failed-item count that aborts the job, when set.",
      +      "type": [
      +        "number",
      +        "null"
      +      ]
      +    },
      +    "finished_at": {
      +      "description": "ISO-8601 time the job reached a terminal status.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "id": {
      +      "description": "Job id. Pass it as `job_id` to the other spicrawl_batch_* tools.",
      +      "type": "string"
      +    },
      +    "max_attempts": {
      +      "description": "Effective attempts per item.",
      +      "type": "number"
      +    },
      +    "name": {
      +      "description": "The label given at submission, if any.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "open": {
      +      "description": "True while the job accepts appended items (it will not complete until closed).",
      +      "type": [
      +        "boolean",
      +        "null"
      +      ]
      +    },
      +    "params": {
      +      "anyOf": [
      +        {
      +          "additionalProperties": {},
      +          "type": "object"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "The job-level scrape settings as stored."
      +    },
      +    "priority": {
      +      "description": "Effective scheduling priority.",
      +      "type": "number"
      +    },
      +    "progress": {
      +      "additionalProperties": true,
      +      "description": "Live item counters and the credits charged so far.",
      +      "properties": {
      +        "bytes": {
      +          "description": "Total response bytes of finished items.",
      +          "type": "number"
      +        },
      +        "cancelled": {
      +          "description": "Items not run because the job was cancelled.",
      +          "type": "number"
      +        },
      +        "completed": {
      +          "description": "Items in any terminal status (succeeded + failed + cancelled + skipped).",
      +          "type": "number"
      +        },
      +        "credits_charged": {
      +          "description": "Credits actually charged so far (whole credits, rounded down).",
      +          "type": "number"
      +        },
      +        "credits_charged_micro": {
      +          "description": "Same as credits_charged in micro-credits (1 credit = 1,000,000).",
      +          "type": "number"
      +        },
      +        "failed": {
      +          "description": "Items that failed after all attempts; re-run them with spicrawl_batch_retry.",
      +          "type": "number"
      +        },
      +        "percent_complete": {
      +          "description": "completed / total x 100.",
      +          "type": "number"
      +        },
      +        "remaining": {
      +          "description": "Items not yet finished (total - completed).",
      +          "type": "number"
      +        },
      +        "skipped": {
      +          "description": "Items skipped (for example after failure_threshold or credit_budget stopped the run).",
      +          "type": "number"
      +        },
      +        "succeeded": {
      +          "description": "Items that succeeded. Only these are charged.",
      +          "type": "number"
      +        },
      +        "total": {
      +          "description": "Items in the job (grows when items are appended to an open job).",
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "project_id": {
      +      "description": "Project the API key belongs to.",
      +      "type": "string"
      +    },
      +    "results_expire_at": {
      +      "description": "ISO-8601 deadline after which results answer 410 Gone.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "results_url": {
      +      "description": "API path of the job's results: /v1/batch/{id}/results.",
      +      "type": "string"
      +    },
      +    "started_at": {
      +      "description": "ISO-8601 time the first item started.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "status": {
      +      "description": "Lifecycle: queued, running, paused, cancelling, completed, failed or cancelled. Keep polling while queued/running/paused/cancelling; stop at completed, failed or cancelled.",
      +      "type": "string"
      +    },
      +    "status_url": {
      +      "description": "API path to poll for this job: /v1/batch/{id}.",
      +      "type": "string"
      +    },
      +    "submitted_at": {
      +      "description": "ISO-8601 time the job was accepted.",
      +      "type": "string"
      +    },
      +    "total_items": {
      +      "description": "Number of items in the job.",
      +      "type": "number"
      +    },
      +    "warnings": {
      +      "anyOf": [
      +        {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Decisions made on the caller's behalf at submission (a clamped concurrency, items not yet queued)."
      +    }
      +  },
      +  "required": [
      +    "id"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so safety is covered; the description adds genuine behavioral context by enumerating the progress counters and credit charging, and by defining which statuses are terminal. It stops short of stating polling cadence, rate limits, or behavior for an unknown/expired job_id.

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?

Two sentences, no filler. The return shape is front-loaded and the lifecycle guidance follows immediately, so the agent gets the essential contract in the first clause.

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?

With an output schema present, the description need not explain the payload, and the polling workflow is fully covered. The only unaddressed edge is failure handling for an invalid or expired job_id, which is minor given the read-only, idempotent annotations.

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 single job_id parameter is fully documented in the schema, including its provenance. The description adds nothing about the parameter itself, so the baseline 3 for schema-carried semantics 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?

States a specific verb and resource ('Return one batch job with its status and progress') and pins the scope to a single job, which cleanly separates it from the list-shaped sibling spicrawl_batch_list. An agent knows exactly what this returns without opening the 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 explicit sequencing: poll this after spicrawl_batch_submit, and once status is completed/failed/cancelled, switch to spicrawl_batch_results. Both the when-to-use and the alternative are named with the condition that selects them.

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