Skip to main content
Glama

Retry a batch job's failed items

spicrawl_batch_retry

Re-queue every FAILED item of a batch job so it runs again (succeeded items are untouched; a job with no failures is returned unchanged). Returns { job, items_reset, items_dispatched }.

Input Schema

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

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
jobNoThe job as it stands after the call.
items_resetNoFailed items reset to queued (0 means nothing had failed).
items_dispatchedNoOf those, how many reached the dispatch queue now; the rest are recovered automatically.

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": {
      +    "items_dispatched": {
      +      "description": "Of those, how many reached the dispatch queue now; the rest are recovered automatically.",
      +      "type": "number"
      +    },
      +    "items_reset": {
      +      "description": "Failed items reset to queued (0 means nothing had failed).",
      +      "type": "number"
      +    },
      +    "job": {
      +      "additionalProperties": true,
      +      "description": "The job as it stands after the call.",
      +      "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"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare the mutation profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false), and the description adds real value on top: only failed items are re-queued, succeeded items are preserved, and a no-failure job is a no-op. It doesn't discuss re-dispatch semantics for a non-idempotent operation (e.g., duplicate side effects), which would have fully earned a 5.

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 tight sentences, front-loaded with the action and its scope, followed by the return shape. Every clause carries information and none is filler.

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?

An output schema exists, so the description needn't detail return values, yet it still names the return fields. The mutation behavior is well covered; only deeper operational detail (auth/session requirements, effect on a currently running job) is absent.

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% and the single job_id parameter is already documented in the schema as coming from spicrawl_batch_submit or spicrawl_batch_list. The description adds nothing about the parameter beyond what the schema states, 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?

States a specific verb ('Re-queue'), resource ('FAILED item of a batch job'), and scope ('every FAILED item', 'succeeded items untouched'). An agent can distinguish this from spicrawl_batch_submit, spicrawl_batch_cancel, and spicrawl_batch_results without opening any schema.

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?

Gives a clear selection condition implicitly by scoping the operation to jobs with failures and noting a job with no failures returns unchanged. It doesn't explicitly name alternative tools (e.g., resubmit vs cancel) for when retry isn't the right move, so it stops short of full when/when-not guidance.

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