firecrawl_check_crawl_status
Monitor the progress and completion status of web crawling jobs initiated through the Firecrawl MCP Server to track data collection processes.
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:1217-1237 (handler)Main handler logic for the firecrawl_check_crawl_status tool. Validates arguments using isStatusCheckOptions, calls client.checkCrawlStatus(id), formats the status response including progress, credits, and results, and returns it as 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: trimResponseText(status) }], isError: false, }; }
- src/index.ts:394-407 (schema)Tool definition including name, description, and input schema that requires a single 'id' string parameter for the crawl job ID.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:960-973 (registration)Registration of all tools including CHECK_CRAWL_STATUS_TOOL in the listTools handler response.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-727 (helper)Type guard function used to validate input arguments for status check tools, ensuring 'id' is a string.function isStatusCheckOptions(args: unknown): args is StatusCheckOptions { return ( typeof args === 'object' && args !== null && 'id' in args && typeof (args as { id: unknown }).id === 'string' ); }
- src/index.ts:625-627 (helper)TypeScript interface defining the expected input shape for status check tools, with required 'id' string.interface StatusCheckOptions { id: string; }