firecrawl-mcp 3.29.0 → 3.30.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 +9 -38
- package/dist/index.js +95 -553
- package/dist/server.d.ts +30 -8
- package/dist/server.js +51 -223
- package/package.json +1 -1
- package/dist/agent-hints.js +0 -46
package/README.md
CHANGED
|
@@ -81,7 +81,7 @@ A fixed-scope search surface is also hosted at:
|
|
|
81
81
|
https://mcp.firecrawl.dev/v2/mcp-search
|
|
82
82
|
```
|
|
83
83
|
|
|
84
|
-
It exposes a fixed set of nine tools: `firecrawl_search`, `firecrawl_developer_search`, `firecrawl_gov_search`, the four `firecrawl_research_*` tools, and the two Alexandria tools `firecrawl_find_tools` and `firecrawl_scrape`. Its `firecrawl_search` fetches no page content
|
|
84
|
+
It exposes a fixed set of nine tools: `firecrawl_search`, `firecrawl_developer_search`, `firecrawl_gov_search`, the four `firecrawl_research_*` tools, and the two Alexandria tools `firecrawl_find_tools` and `firecrawl_scrape`. Its `firecrawl_search` fetches no page content.
|
|
85
85
|
|
|
86
86
|
### Running with npx
|
|
87
87
|
|
|
@@ -280,20 +280,18 @@ Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace
|
|
|
280
280
|
|
|
281
281
|
#### MCP OAuth (Bearer access tokens)
|
|
282
282
|
|
|
283
|
-
|
|
283
|
+
Firecrawl issues OAuth **access tokens** (`fco_…`) via the authorization server on [firecrawl.dev](https://firecrawl.dev). This MCP server forwards whichever credential it resolves to the Firecrawl API as `Authorization: Bearer …`.
|
|
284
284
|
|
|
285
285
|
- **HTTP stream transports** (`CLOUD_SERVICE=true`, `HTTP_STREAMABLE_SERVER=true`, or `SSE_LOCAL=true`): Clients should send `Authorization: Bearer <fco_access_token>` on MCP requests. An OAuth bearer token takes precedence over `x-firecrawl-api-key` / `x-api-key` when both are present.
|
|
286
286
|
- **stdio:** Use `FIRECRAWL_OAUTH_TOKEN` for a static access token, or keep using `FIRECRAWL_API_KEY` for an API key.
|
|
287
287
|
|
|
288
288
|
Use **access** tokens (`fco_…`) only. Refresh tokens (`fcr_…`) must be exchanged at the token endpoint, not passed to the scrape/search API.
|
|
289
289
|
|
|
290
|
-
####
|
|
290
|
+
#### `CLOUD_SERVICE=true`
|
|
291
291
|
|
|
292
|
-
|
|
292
|
+
`CLOUD_SERVICE=true` serves the tools over streamable HTTP on `PORT` (default `3000`, bound to `0.0.0.0`) with stricter defaults: every request must carry a credential (an API key or an OAuth access token), scrape is read-only (see the scrape tool below), and `firecrawl_parse` accepts uploads only.
|
|
293
293
|
|
|
294
|
-
`
|
|
295
|
-
|
|
296
|
-
The search instance requires authentication for every request (including `tools/list`) and rejects OAuth tokens whose audience does not match its own resource.
|
|
294
|
+
`FASTMCP_ENDPOINT` selects the tool surface: `/v2/mcp` (default) for the full tool set, `/v2/mcp-oauth` for the account surface, or `/v2/mcp-search` for the search-only tools (this also requires `FIRECRAWL_MCP_SEARCH_OAUTH_ONLY=true`). With the full surface, a search-only instance also starts on port `3001`; set `FIRECRAWL_MCP_SEARCH_ENABLED=false` to turn it off.
|
|
297
295
|
|
|
298
296
|
### Configuration Examples
|
|
299
297
|
|
|
@@ -453,7 +451,7 @@ Scrape content from a single URL with advanced options.
|
|
|
453
451
|
|
|
454
452
|
**Branding format:** Extracts comprehensive brand identity (colors, fonts, typography, spacing, logo, UI components) for design analysis or style replication.
|
|
455
453
|
**Privacy:** Set `redactPII: true` to return content with personally identifiable information redacted.
|
|
456
|
-
**
|
|
454
|
+
**With `CLOUD_SERVICE=true`:** scrape is read-only. It takes no browser `actions` and cannot accept provider terms. A named `profile` loads saved browser state without saving changes to it, and the full endpoint's `firecrawl_search` treats `scrapeOptions.profile` the same way. To save browser state to a profile, open the page with `firecrawl_interact` (see below). An organization admin accepts terms in the dashboard.
|
|
457
455
|
|
|
458
456
|
**Returns:**
|
|
459
457
|
|
|
@@ -692,11 +690,11 @@ Check the status and results of an existing crawl job by ID.
|
|
|
692
690
|
|
|
693
691
|
Parse local files or hosted upload references with Firecrawl's `/v2/parse` endpoint.
|
|
694
692
|
|
|
695
|
-
**Best for:** PDFs, Word documents, spreadsheets, HTML files, and other documents that need markdown or structured JSON output.
|
|
693
|
+
**Best for:** PDFs, Word documents, spreadsheets, HTML files, and other documents that need markdown or structured JSON output. The hosted endpoint uses a two-step upload flow; local direct file reads require a self-hosted `FIRECRAWL_API_URL`.
|
|
696
694
|
|
|
697
695
|
**Not recommended for:** Remote URLs (use scrape), multiple files in one call (call parse once per file), or browser-only actions such as screenshots and clicks.
|
|
698
696
|
|
|
699
|
-
**Hosted
|
|
697
|
+
**Hosted endpoint:** it cannot read your filesystem. Call `firecrawl_parse` with `filePath` to receive a short-lived upload command and `nextToolCall`, upload the file locally, then call `firecrawl_parse` again with the returned `uploadRef`. The upload step requires Firecrawl auth or the keyless tier. In local `npx firecrawl-mcp` mode, direct file parsing currently requires `FIRECRAWL_API_URL` pointing to a self-hosted Firecrawl API; a plain cloud API-key-only local server cannot read and upload files through this tool.
|
|
700
698
|
|
|
701
699
|
**Usage Example:**
|
|
702
700
|
|
|
@@ -1235,7 +1233,7 @@ Options mirror the CLI's environment variables: `apiUrl`, `apiKey`, `transport`,
|
|
|
1235
1233
|
|---|---|
|
|
1236
1234
|
| `authenticate(request)` | Resolve the session for a request; throw a `Response` to reject it. |
|
|
1237
1235
|
| `wrapTool(tool)` | Decorate every registered tool. |
|
|
1238
|
-
| `onToolResult(event)` | Observe the start and outcome of each tool call
|
|
1236
|
+
| `onToolResult(event)` | Observe the start and outcome of each tool call. |
|
|
1239
1237
|
| `instructions` | Server instructions, or a function choosing from the defaults. |
|
|
1240
1238
|
| `registerExtraTools(registrar, context)` | Add tools after the built-in ones. |
|
|
1241
1239
|
| `outboundRequest(session)` | Credential and extra headers for each Firecrawl API request. |
|
|
@@ -1265,33 +1263,6 @@ Example log messages:
|
|
|
1265
1263
|
[ERROR] Rate limit exceeded
|
|
1266
1264
|
```
|
|
1267
1265
|
|
|
1268
|
-
## API response hints
|
|
1269
|
-
|
|
1270
|
-
The MCP server explicitly enables Firecrawl API response hints on its outbound
|
|
1271
|
-
requests with `X-Firecrawl-Agent-Hints: true`; the API leaves them disabled for
|
|
1272
|
-
ordinary callers. When Firecrawl returns an optional `agent_hints` array of
|
|
1273
|
-
strings, JSON tool results preserve it in their existing text and
|
|
1274
|
-
`structuredContent` alongside the tool's other structured fields. Readable
|
|
1275
|
-
Developer and Research outputs keep their existing text and show hints in a
|
|
1276
|
-
separate, labeled text block. Empty results can include hints. Error hints
|
|
1277
|
-
remain visible with `isError: true`.
|
|
1278
|
-
Responses without hints keep their existing output format. Guidance is API
|
|
1279
|
-
metadata, separate from the scraped page's content; it is not generated or
|
|
1280
|
-
executed by the MCP adapter.
|
|
1281
|
-
|
|
1282
|
-
The strings are passed through unchanged. An HTTP operation mentioned in a
|
|
1283
|
-
hint is not necessarily an MCP tool: Alexandria discovery is available through
|
|
1284
|
-
`firecrawl_find_tools`, and provider execution uses `firecrawl_scrape` with an
|
|
1285
|
-
`alexandria` body. The search-only profile exposes those paths and URL-mode
|
|
1286
|
-
Scrape, but does not expose feedback tools. Clients should use their advertised
|
|
1287
|
-
tool schemas and available capabilities. This change does not add tools,
|
|
1288
|
-
translate prose into tool calls, or submit feedback automatically.
|
|
1289
|
-
|
|
1290
|
-
The pinned `firecrawl` 4.40.0 discards outer-envelope hints in high-level
|
|
1291
|
-
Scrape and Map responses and normalized SDK errors. The adapter captures hints
|
|
1292
|
-
from the SDK HTTP response while retaining the SDK's request and retry behavior.
|
|
1293
|
-
Authentication recovery retains its existing guidance.
|
|
1294
|
-
|
|
1295
1266
|
## Error Handling
|
|
1296
1267
|
|
|
1297
1268
|
The server provides robust error handling:
|