@ever-works/firecrawl-plugin
v1.0.3
Published
Firecrawl Plugin - Web search and content extraction using the Firecrawl API
Readme
@ever-works/firecrawl-plugin
Firecrawl Plugin - Web search and content extraction using the Firecrawl API
Plugin metadata
| Field | Value |
| ------------ | ----------------------------- |
| ID | firecrawl |
| Category | search |
| Capabilities | search, content-extractor |
| Author | Ever Works Team |
| License | AGPL-3.0 |
| Built-in | yes |
| Auto-enable | no |
What does Firecrawl do?
Firecrawl is a web scraping and search API that can search the web for relevant results and extract clean, well-formatted markdown content from any web page. It handles JavaScript rendering, anti-bot bypasses, and content cleaning automatically.
Why use it?
- Web search — search the web and get structured results with content snippets
- Clean markdown output — returns well-structured markdown from any web page
- JavaScript rendering — handles dynamic/SPA pages that simple HTTP fetches miss
- Anti-bot handling — bypasses common protections automatically
- Metadata extraction — captures title, description, and other page metadata
How it works in Ever Works
When enabled, Firecrawl can be used as both a search provider and content extractor during work generation. It searches the web for relevant information and extracts high-quality content from web pages, including JavaScript-heavy sites.
Getting started
- Create an account at firecrawl.dev
- Copy your API key from the Firecrawl dashboard
- Enter the key in the API Key field below
- Enable this plugin to use it for search and content extraction
Settings
- API Key (
apiKey) — required, secret. Your Firecrawl API key (also configurable via thePLUGIN_FIRECRAWL_API_KEYenvironment variable). - Stored at user scope so each user can supply their own credentials.
- Configuration mode is
hybrid— admins can preset values and users may override them.
Troubleshooting
| Symptom | Likely cause | Fix |
| -------------------------------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 401 Unauthorized / Authentication failed | API key missing, revoked, or wrong key entered | Re-enter the API Key from the Firecrawl dashboard, or set PLUGIN_FIRECRAWL_API_KEY in the host environment for default fallback |
| 429 Too Many Requests | Free-tier or paid quota exhausted on Firecrawl | Throttle calls, wait for the quota reset, or upgrade the plan in the Firecrawl dashboard |
| Empty / sparse results | Query is too restrictive, time-range or domain filters are too narrow | Broaden the query, relax time_range / safesearch / include_domains / exclude_domains filters, or raise max_results |
| Plugin not used during work generation | Another search plugin is set as the default for the search capability | In Settings → Plugins, set firecrawl as the default for search, or disable competing search plugins |
| Failed to extract content for a URL | Page is gated by login, Cloudflare, or robots.txt; URL is malformed | Verify the URL is publicly reachable; for protected pages enable a different content-extractor plugin (scrapfly, notion-extractor, pdf-extractor) |
| healthCheck reports unhealthy | API key invalid OR Firecrawl endpoint unreachable from the host | Verify the key with a manual curl against the documented endpoint and confirm outbound HTTPS is allowed by the firewall |
Local development
This plugin ships built-in with the Ever Works platform. To work on it locally from the monorepo root:
pnpm install
pnpm --filter @ever-works/firecrawl-plugin build
pnpm --filter @ever-works/firecrawl-plugin testDocumentation
License
AGPL-3.0
