Docs: sync README with the actual tools and install methods#272
Open
rakshith48 wants to merge 2 commits into
Open
Docs: sync README with the actual tools and install methods#272rakshith48 wants to merge 2 commits into
rakshith48 wants to merge 2 commits into
Conversation
The README had drifted from the code and the docs. Verified the registered tools against src/ (server.addTool) on main and reconciled both. Tools: - Remove firecrawl_batch_scrape / firecrawl_check_batch_status — not registered in the code (only referenced in prose / legacy). - Add firecrawl_parse (local-file parse via self-hosted /v2/parse), firecrawl_interact, firecrawl_interact_stop, and the firecrawl_research_* suite (arXiv + GitHub, gated on research access) — all present in code, previously undocumented. - Renumber the Available Tools sections and refresh the quick-reference table and "How to Choose a Tool" guidance. Install & params: - Add the remote hosted URL (https://mcp.firecrawl.dev/{KEY}/v2/mcp) plus Claude Code, Google Antigravity, and n8n sections. - Fix the local Streamable HTTP path /mcp -> /v2/mcp. - Fix crawl maxDepth -> maxDiscoveryDepth; modernize search params (lang/country -> location/sources). - Features: "SSE support" -> "Streamable HTTP support"; add monitor + research bullets. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ntal - Remove the firecrawl_extract tool section + table row (per product direction). - Parse: clarify it is self-hosted only (registered only when CLOUD_SERVICE != true). - Research: reframe as experimental/opt-in (FIRECRAWL_RESEARCH=true or ?research=true); not exposed on the standard hosted MCP. - Remove remaining stale batch_scrape prose references. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README had drifted from both the code and the docs. I verified the registered tools and their availability guards against
src/onmain(v3.20.4) and brought the README in line with what the hosted MCP actually exposes.Tools
firecrawl_batch_scrape+firecrawl_check_batch_status— not registered in the code (only in prose /src/legacy/). Also cleaned up stalebatch_scrapeprose references.firecrawl_extractsection (per product direction).firecrawl_parse— self-hosted only (registered only whenCLOUD_SERVICE !== 'true'; needsFIRECRAWL_API_URL).firecrawl_interact/firecrawl_interact_stop.firecrawl_research_*— experimental / opt-in (FIRECRAWL_RESEARCH=trueor?research=true); not on the standard hosted MCP.Install & params
https://mcp.firecrawl.dev/{KEY}/v2/mcp) and Claude Code / Google Antigravity / n8n sections./mcp→/v2/mcp.maxDepth→maxDiscoveryDepth; modernized search params (lang/country→location/sources).Note for maintainers
The published docs at docs.firecrawl.dev/mcp-server still list a browser-session suite (
firecrawl_browser_create/execute/delete/list) that is not in the code — looks like a docs bug (flagging separately; not touched here).🤖 Generated with Claude Code