firecrawl-mcp 3.22.3 → 3.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -0
- package/dist/index.js +826 -856
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -44,6 +44,16 @@ https://mcp.firecrawl.dev/{FIRECRAWL_API_KEY}/v2/mcp
|
|
|
44
44
|
|
|
45
45
|
See the [MCP server docs](https://docs.firecrawl.dev/mcp-server) and the [agent onboarding guide](https://www.firecrawl.dev/agent-onboarding/SKILL.md) for setup details.
|
|
46
46
|
|
|
47
|
+
#### Search-only endpoint
|
|
48
|
+
|
|
49
|
+
A read-only, search-only surface is also hosted at:
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
https://mcp.firecrawl.dev/v2/mcp-search
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
It exposes a fixed set of six read-only tools: `firecrawl_search` and the five `firecrawl_research_*` tools. It performs no page-content fetching and has its own OAuth identity; the full endpoint above is unchanged. See [docs/search-profile.md](docs/search-profile.md) for the full contract.
|
|
56
|
+
|
|
47
57
|
### Running with npx
|
|
48
58
|
|
|
49
59
|
```bash
|
|
@@ -213,6 +223,14 @@ Hosted Firecrawl can issue OAuth **access tokens** (`fco_…`) via the authoriza
|
|
|
213
223
|
|
|
214
224
|
Use **access** tokens (`fco_…`) only. Refresh tokens (`fcr_…`) must be exchanged at the token endpoint, not passed to the scrape/search API.
|
|
215
225
|
|
|
226
|
+
#### Search-only surface (hosted)
|
|
227
|
+
|
|
228
|
+
In hosted mode (`CLOUD_SERVICE=true`) a second in-process instance serves the [search-only endpoint](#search-only-endpoint). The bundled service has a fixed deployment contract: nginx routes `/v2/mcp-search` to the instance on local port `3001`, and the OAuth protected-resource identifier is `https://mcp.firecrawl.dev/v2/mcp-search`.
|
|
229
|
+
|
|
230
|
+
`FIRECRAWL_MCP_SEARCH_ENABLED` (default `true`) is the supported operational toggle; set it to `false` to prevent the search instance from starting. The Node process also accepts `FIRECRAWL_MCP_SEARCH_PORT`, `FIRECRAWL_MCP_SEARCH_ENDPOINT`, and `FIRECRAWL_MCP_SEARCH_RESOURCE_URL` for isolated tests. Those overrides do not reconfigure the bundled nginx routes or the authorization server allowlist and must not be used independently in the hosted deployment.
|
|
231
|
+
|
|
232
|
+
The search instance requires authentication for every request (including `tools/list`) and rejects OAuth tokens whose audience does not match its own resource.
|
|
233
|
+
|
|
216
234
|
### Configuration Examples
|
|
217
235
|
|
|
218
236
|
For cloud API usage:
|
|
@@ -432,6 +450,7 @@ Search the web and optionally extract content from search results.
|
|
|
432
450
|
"name": "firecrawl_search",
|
|
433
451
|
"arguments": {
|
|
434
452
|
"query": "latest AI research papers 2023",
|
|
453
|
+
"highlights": true,
|
|
435
454
|
"limit": 5,
|
|
436
455
|
"lang": "en",
|
|
437
456
|
"country": "us",
|
|
@@ -444,6 +463,8 @@ Search the web and optionally extract content from search results.
|
|
|
444
463
|
}
|
|
445
464
|
```
|
|
446
465
|
|
|
466
|
+
Set `highlights` to `true` to request query-relevant highlights or `false` to keep the original search snippets. Omit it to use the API's default behavior.
|
|
467
|
+
|
|
447
468
|
**Returns:**
|
|
448
469
|
|
|
449
470
|
- Array of search results (with optional scraped content), plus an `id` field. Pass that `id` to `firecrawl_search_feedback` after you've used the results to refund 1 credit (search costs 2) and improve search quality.
|