docs: add Firecrawl section to README

This commit is contained in:
Leonardo Grigorio
2026-04-02 13:47:59 -03:00
parent ac4efae870
commit 63daf33b48

View File

@@ -123,6 +123,27 @@ Best if you want local inference on Apple Silicon with Atomic Chat. See [Advance
---
## Web Search and Fetch
By default, `WebSearch` is disabled for all non-Anthropic providers. The native search backend requires either the Anthropic API or the Codex responses endpoint, so users on GPT-4o, DeepSeek, Gemini, Ollama, and other OpenAI-compatible providers get no web search at all.
`WebFetch` works but uses basic HTTP plus HTML-to-markdown conversion. That fails on JavaScript-rendered pages (React, Next.js, Vue SPAs) and sites that block plain HTTP requests.
Set a [Firecrawl](https://firecrawl.dev) API key to fix both:
```bash
export FIRECRAWL_API_KEY=your-key-here
```
With this set:
- `WebSearch` is enabled for all providers and routes through Firecrawl's search API
- `WebFetch` uses Firecrawl's scrape endpoint instead of raw HTTP, handling JS-rendered pages correctly
Free tier at [firecrawl.dev](https://firecrawl.dev) includes 500 credits. The key is optional — if not set, both tools fall back to their original behavior.
---
## How It Works
The shim (`src/services/api/openaiShim.ts`) sits between Claude Code and the LLM API: