import { createLogger } from '@sim/logger' import { sleep } from '@sim/utils/helpers' import { DEFAULT_EXECUTION_TIMEOUT_MS } from '@/lib/core/execution-limits' import type { FirecrawlCrawlParams, FirecrawlCrawlResponse } from '@/tools/firecrawl/types' import { CRAWLED_PAGE_OUTPUT_PROPERTIES } from '@/tools/firecrawl/types' import type { ToolConfig } from '@/tools/types' const logger = createLogger('FirecrawlCrawlTool') const POLL_INTERVAL_MS = 5000 const MAX_POLL_TIME_MS = DEFAULT_EXECUTION_TIMEOUT_MS export const crawlTool: ToolConfig = { id: 'firecrawl_crawl', name: 'Firecrawl Crawl', description: 'Crawl entire websites and extract structured content from all accessible pages', version: '1.0.0', params: { url: { type: 'string', required: true, visibility: 'user-or-llm', description: 'The website URL to crawl (e.g., "https://example.com" or "https://docs.example.com/guide")', }, limit: { type: 'number', required: false, visibility: 'user-or-llm', description: 'Maximum number of pages to crawl (e.g., 50, 100, 500). Default: 100', }, maxDepth: { type: 'number', required: false, visibility: 'user-or-llm', description: 'Maximum depth to crawl from the starting URL (e.g., 1, 2, 3). Controls how many levels deep to follow links', }, formats: { type: 'json', required: false, visibility: 'user-or-llm', description: 'Output formats for scraped content (e.g., ["markdown"], ["markdown", "html"], ["markdown", "links"])', }, excludePaths: { type: 'json', required: false, visibility: 'user-or-llm', description: 'URL paths to exclude from crawling (e.g., ["/blog/*", "/admin/*", "/*.pdf"])', }, includePaths: { type: 'json', required: false, visibility: 'user-or-llm', description: 'URL paths to include in crawling (e.g., ["/docs/*", "/api/*"]). Only these paths will be crawled', }, onlyMainContent: { type: 'boolean', required: false, visibility: 'user-only', description: 'Extract only main content from pages', }, apiKey: { type: 'string', required: true, visibility: 'user-only', description: 'Firecrawl API Key', }, }, hosting: { envKeyPrefix: 'FIRECRAWL_API_KEY', apiKeyParam: 'apiKey', byokProviderId: 'firecrawl', pricing: { type: 'custom', getCost: (_params, output) => { if (output.creditsUsed == null) { throw new Error('Firecrawl response missing creditsUsed field') } const creditsUsed = Number(output.creditsUsed) if (Number.isNaN(creditsUsed)) { throw new Error('Firecrawl response returned a non-numeric creditsUsed field') } return { cost: creditsUsed * 0.001, metadata: { creditsUsed }, } }, }, rateLimit: { mode: 'per_request', requestsPerMinute: 100, }, }, request: { url: 'https://api.firecrawl.dev/v2/crawl', method: 'POST', headers: (params) => ({ 'Content-Type': 'application/json', Authorization: `Bearer ${params.apiKey}`, }), body: (params) => { const body: Record = { url: params.url, limit: Number(params.limit) || 100, scrapeOptions: params.scrapeOptions || { formats: params.formats || ['markdown'], onlyMainContent: params.onlyMainContent || false, }, } if (params.prompt) body.prompt = params.prompt if (params.maxDepth) body.maxDiscoveryDepth = Number(params.maxDepth) if (params.maxDiscoveryDepth) body.maxDiscoveryDepth = Number(params.maxDiscoveryDepth) if (params.sitemap) body.sitemap = params.sitemap if (typeof params.crawlEntireDomain === 'boolean') body.crawlEntireDomain = params.crawlEntireDomain if (typeof params.allowExternalLinks === 'boolean') body.allowExternalLinks = params.allowExternalLinks if (typeof params.allowSubdomains === 'boolean') body.allowSubdomains = params.allowSubdomains if (typeof params.ignoreQueryParameters === 'boolean') body.ignoreQueryParameters = params.ignoreQueryParameters if (params.delay) body.delay = Number(params.delay) if (params.maxConcurrency) body.maxConcurrency = Number(params.maxConcurrency) if (params.excludePaths) body.excludePaths = params.excludePaths if (params.includePaths) body.includePaths = params.includePaths if (params.webhook) body.webhook = params.webhook if (typeof params.zeroDataRetention === 'boolean') body.zeroDataRetention = params.zeroDataRetention return body }, }, transformResponse: async (response: Response) => { const data = await response.json() return { success: true, output: { jobId: data.jobId || data.id, pages: [], total: 0, creditsUsed: 0, }, } }, postProcess: async (result, params) => { if (!result.success) { return result } const jobId = result.output.jobId logger.info(`Firecrawl crawl job ${jobId} created, polling for completion...`) let elapsedTime = 0 while (elapsedTime < MAX_POLL_TIME_MS) { try { const statusResponse = await fetch(`https://api.firecrawl.dev/v2/crawl/${jobId}`, { method: 'GET', headers: { Authorization: `Bearer ${params.apiKey}`, 'Content-Type': 'application/json', }, }) if (!statusResponse.ok) { throw new Error(`Failed to get crawl status: ${statusResponse.statusText}`) } const crawlData = await statusResponse.json() logger.info(`Firecrawl crawl job ${jobId} status: ${crawlData.status}`) if (crawlData.status === 'completed') { result.output = { pages: crawlData.data || [], total: crawlData.total || 0, creditsUsed: crawlData.creditsUsed || 0, } return result } if (crawlData.status === 'failed') { return { ...result, success: false, error: `Crawl job failed: ${crawlData.error || 'Unknown error'}`, } } await sleep(POLL_INTERVAL_MS) elapsedTime += POLL_INTERVAL_MS } catch (error: any) { logger.error('Error polling for crawl job status:', { message: error.message || 'Unknown error', jobId, }) return { ...result, success: false, error: `Error polling for crawl job status: ${error.message || 'Unknown error'}`, } } } logger.warn( `Crawl job ${jobId} did not complete within the maximum polling time (${MAX_POLL_TIME_MS / 1000}s)` ) return { ...result, success: false, error: `Crawl job did not complete within the maximum polling time (${MAX_POLL_TIME_MS / 1000}s)`, } }, outputs: { pages: { type: 'array', description: 'Array of crawled pages with their content and metadata', items: { type: 'object', properties: CRAWLED_PAGE_OUTPUT_PROPERTIES, }, }, total: { type: 'number', description: 'Total number of pages found during crawl' }, }, }