docs(readme): align scrape JSON format example with jsonOptions API - #372
Open
syf2211 wants to merge 1 commit into
Open
docs(readme): align scrape JSON format example with jsonOptions API#372syf2211 wants to merge 1 commit into
syf2211 wants to merge 1 commit into
Conversation
The firecrawl_scrape tool section showed an object inside formats, which the MCP schema rejects. Use formats: ["json"] with prompt/schema in jsonOptions, matching src/index.ts and the later README section. Fixes firecrawl#357
There was a problem hiding this comment.
No issues found across 1 file
Auto-approved: Docs-only fix correcting the README JSON example to match the actual API shape (formats: ["json"] plus jsonOptions); no code, behavior, or operational changes.
Re-trigger cubic
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
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.
Summary
Fix the
firecrawl_scrapetool section JSON example so it usesformats: ["json"]withpromptandschemainjsonOptions, matching the MCP tool schema andsrc/index.ts.Motivation
Fixes #357. The scrape tool section showed an object inside
formats, which the MCP server rejects with a-32602validation error. New users copying the "preferred" JSON example hit this immediately. The keyless tier sentence onmainalready listsscrape,search, andparse(notinteract).Changes
formats: ["json"]+jsonOptionsinstead of an object informats.Tests
formatsexamples; branding and searchscrapeOptionsalready use string format arrays.Notes
Fixes #357
Summary by cubic
Updates the README example for
firecrawl_scrapeto useformats: ["json"]withjsonOptions(prompt,schema). This matches the tool API and avoids MCP-32602validation errors when users copy the example.formatsfrom an object to an array and movepromptandschemaintojsonOptions.Written for commit 0198943. Summary will update on new commits.