firecrawl_check_batch_status
Monitor the progress of a web scraping batch job by checking its current status using the job ID.
Instructions
Check the status of a batch scraping job.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Batch job ID to check |
Implementation Reference
- src/index.ts:1147-1181 (handler)The handler function that executes the tool logic: validates input, retrieves batch operation status from the map, and formats the response with status, progress, error, and results.case 'firecrawl_check_batch_status': { if (!isStatusCheckOptions(args)) { throw new Error('Invalid arguments for firecrawl_check_batch_status'); } const operation = batchOperations.get(args.id); if (!operation) { return { content: [ { type: 'text', text: trimResponseText( `No batch operation found with ID: ${args.id}` ), }, ], isError: true, }; } const status = `Batch Status: Status: ${operation.status} Progress: ${operation.progress.completed}/${operation.progress.total} ${operation.error ? `Error: ${operation.error}` : ''} ${ operation.result ? `Results: ${JSON.stringify(operation.result, null, 2)}` : '' }`; return { content: [{ type: 'text', text: trimResponseText(status) }], isError: false, }; }
- src/index.ts:379-392 (schema)Tool schema defining the name, description, and input schema (requires 'id' string) for firecrawl_check_batch_status.const CHECK_BATCH_STATUS_TOOL: Tool = { name: 'firecrawl_check_batch_status', description: 'Check the status of a batch scraping job.', inputSchema: { type: 'object', properties: { id: { type: 'string', description: 'Batch job ID to check', }, }, required: ['id'], }, };
- src/index.ts:960-973 (registration)Registration of the tool in the MCP server's listTools request handler, including CHECK_BATCH_STATUS_TOOL in the tools array.server.setRequestHandler(ListToolsRequestSchema, async () => ({ tools: [ SCRAPE_TOOL, MAP_TOOL, CRAWL_TOOL, BATCH_SCRAPE_TOOL, CHECK_BATCH_STATUS_TOOL, CHECK_CRAWL_STATUS_TOOL, SEARCH_TOOL, EXTRACT_TOOL, DEEP_RESEARCH_TOOL, GENERATE_LLMSTXT_TOOL, ], }));
- src/index.ts:720-726 (helper)Type guard helper function used in the handler to validate input arguments for the tool.function isStatusCheckOptions(args: unknown): args is StatusCheckOptions { return ( typeof args === 'object' && args !== null && 'id' in args && typeof (args as { id: unknown }).id === 'string' );