Skip to content

docs(readme): align scrape JSON format example with jsonOptions API - #372

Open
syf2211 wants to merge 1 commit into
firecrawl:mainfrom
syf2211:docs/readme-formats-jsonoptions-357
Open

docs(readme): align scrape JSON format example with jsonOptions API#372
syf2211 wants to merge 1 commit into
firecrawl:mainfrom
syf2211:docs/readme-formats-jsonoptions-357

Conversation

@syf2211

@syf2211 syf2211 commented Aug 15, 2026

Copy link
Copy Markdown

Summary

Fix the firecrawl_scrape tool section JSON example so it uses formats: ["json"] with prompt and schema in jsonOptions, matching the MCP tool schema and src/index.ts.

Motivation

Fixes #357. The scrape tool section showed an object inside formats, which the MCP server rejects with a -32602 validation error. New users copying the "preferred" JSON example hit this immediately. The keyless tier sentence on main already lists scrape, search, and parse (not interact).

Changes

  • Update the scrape tool Usage Example (JSON format - preferred) to use formats: ["json"] + jsonOptions instead of an object in formats.
  • No code changes; section 7 ("Structured data with Scrape JSON") already showed the correct shape.

Tests

  • Docs-only change; no build or test commands required.
  • Verified README grep: no remaining object-in-formats examples; branding and search scrapeOptions already use string format arrays.

Notes

  • composer-2.5 review: APPROVE
  • Minimal diff focused on the first example users are told to copy.

Fixes #357


Summary by cubic

Updates the README example for firecrawl_scrape to use formats: ["json"] with jsonOptions (prompt, schema). This matches the tool API and avoids MCP -32602 validation errors when users copy the example.

  • Migration
    • If you copied the previous example, change formats from an object to an array and move prompt and schema into jsonOptions.

Written for commit 0198943. Summary will update on new commits.

Review in cubic

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

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README: keyless tool list and formats object syntax both disagree with v3.23.3 behavior

1 participant