Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| FIRECRAWL_API_KEY | No | Your Firecrawl API key (required for cloud API, optional for self-hosted instances) | |
| FIRECRAWL_API_URL | No | Custom API endpoint for self-hosted instances (e.g., https://firecrawl.your-domain.com). If not provided, the cloud API will be used. | |
| FIRECRAWL_RETRY_MAX_DELAY | No | Maximum delay in milliseconds between retries | 10000 |
| FIRECRAWL_RETRY_MAX_ATTEMPTS | No | Maximum number of retry attempts for rate-limited requests | 3 |
| FIRECRAWL_RETRY_INITIAL_DELAY | No | Initial delay in milliseconds before first retry | 1000 |
| FIRECRAWL_RETRY_BACKOFF_FACTOR | No | Exponential backoff multiplier | 2 |
| FIRECRAWL_CREDIT_WARNING_THRESHOLD | No | Credit usage warning threshold | 1000 |
| FIRECRAWL_CREDIT_CRITICAL_THRESHOLD | No | Credit usage critical threshold | 100 |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| firecrawl_scrape | Scrape a single webpage with advanced options for content extraction. Supports various formats including markdown, HTML, and screenshots. Can execute custom actions like clicking or scrolling before scraping. |
| firecrawl_map | Discover URLs from a starting point. Can use both sitemap.xml and HTML link discovery. |
| firecrawl_crawl | Start an asynchronous crawl of multiple pages from a starting URL. Supports depth control, path filtering, and webhook notifications. |
| firecrawl_batch_scrape | Scrape multiple URLs in batch mode. Returns a job ID that can be used to check status. |
| firecrawl_check_batch_status | Check the status of a batch scraping job. |
| firecrawl_check_crawl_status | Check the status of a crawl job. |
| firecrawl_search | Search and retrieve content from web pages with optional scraping. Returns SERP results by default (url, title, description) or full page content when scrapeOptions are provided. |
| firecrawl_extract | Extract structured information from web pages using LLM. Supports both cloud AI and self-hosted LLM extraction. |
| firecrawl_deep_research | Conduct deep research on a query using web crawling, search, and AI analysis. |
| firecrawl_generate_llmstxt | Generate standardized LLMs.txt file for a given URL, which provides context about how LLMs should interact with the website. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |