firecrawl_check_crawl_status
Monitor the progress and completion status of web crawling jobs initiated through the Firecrawl API.
Instructions
Check the status of a crawl job.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Crawl job ID to check |
Implementation Reference
- src/index.ts:1099-1121 (handler)The handler logic for 'firecrawl_check_crawl_status'. Validates the input arguments using isStatusCheckOptions, calls the Firecrawl client's checkCrawlStatus method with the provided job ID, formats a status message including status, progress, credits used, expiration, and a preview of results using formatResults, then returns the formatted content.
case 'firecrawl_check_crawl_status': { if (!isStatusCheckOptions(args)) { throw new Error( 'Invalid arguments for firecrawl_check_crawl_status' ); } const response = await client.checkCrawlStatus(args.id); if (!response.success) { throw new Error(response.error); } const status = `Crawl Status: Status: ${response.status} Progress: ${response.completed}/${response.total} Credits Used: ${response.creditsUsed} Expires At: ${response.expiresAt} ${ response.data.length > 0 ? '\nResults:\n' + formatResults(response.data) : '' }`; return { content: [{ type: 'text', text: status }], isError: false, }; } - src/index.ts:393-406 (schema)The Tool schema definition for 'firecrawl_check_crawl_status', specifying the name, description, and inputSchema that requires a string 'id' for the crawl job.
const CHECK_CRAWL_STATUS_TOOL: Tool = { name: 'firecrawl_check_crawl_status', description: 'Check the status of a crawl job.', inputSchema: { type: 'object', properties: { id: { type: 'string', description: 'Crawl job ID to check', }, }, required: ['id'], }, }; - src/index.ts:863-873 (registration)Registration of the CHECK_CRAWL_STATUS_TOOL in the list of tools returned by the ListToolsRequestSchema handler.
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, ], - src/index.ts:649-656 (helper)Helper type guard function used to validate the input arguments for status check tools, ensuring it has a string 'id' property.
function isStatusCheckOptions(args: unknown): args is StatusCheckOptions { return ( typeof args === 'object' && args !== null && 'id' in args && typeof (args as { id: unknown }).id === 'string' ); }