firecrawl_check_crawl_status
Monitor the progress and completion status of web crawling jobs to track data collection tasks.
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)The main handler logic for the 'firecrawl_check_crawl_status' tool. It validates arguments using isStatusCheckOptions, calls client.checkCrawlStatus(id), formats the status response, and returns it.
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)The Tool object defining the name, description, and input schema (requiring 'id' string) for 'firecrawl_check_crawl_status'.
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-974 (registration)Registration of all tools including 'firecrawl_check_crawl_status' (as CHECK_CRAWL_STATUS_TOOL) in the ListToolsRequestSchema handler.
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 isStatusCheckOptions used to validate input arguments for status check tools, including firecrawl_check_crawl_status.
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)Type interface StatusCheckOptions defining the expected input shape {id: string} for status check tools.
interface StatusCheckOptions { id: string; }