Skip to content

Add agent quickstart docs for all SDK languages - #1197

Draft
ericciarla wants to merge 2 commits into
mainfrom
claude/eager-dijkstra-eiyh7n
Draft

Add agent quickstart docs for all SDK languages#1197
ericciarla wants to merge 2 commits into
mainfrom
claude/eager-dijkstra-eiyh7n

Conversation

@ericciarla

@ericciarla ericciarla commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds one canonical quickstart document per SDK language (Node.js, Python, Rust, Java, Elixir) in agent-quickstart/
  • Each file covers search, scrape, and interact endpoints with complete parameter references
  • All content generated from SDK source code and OpenAPI spec — no invented parameters or behavior
  • Files are Mintlify-compatible MDX, designed to be pasted directly into agent context

What's included per quickstart

  • Install command
  • Auth/constructor pattern
  • When-to-use-what decision guide
  • For each endpoint: why to use it, preferred SDK method, working example, every confirmed parameter with description
  • Language-specific notes (naming conventions, deprecated aliases, SDK quirks)
  • Source of truth listing

Languages

File SDK Package Naming Style
agent-quickstart/node.mdx @mendable/firecrawl-js camelCase
agent-quickstart/python.mdx firecrawl-py snake_case
agent-quickstart/rust.mdx firecrawl (crate) snake_case structs
agent-quickstart/java.mdx com.firecrawl:firecrawl-java camelCase, builder pattern
agent-quickstart/elixir.mdx :firecrawl (hex) snake_case, OpenAPI-shaped functions

Test plan

  • Verify each .mdx file renders correctly in Mintlify dev server
  • Cross-check parameter tables against SDK source for accuracy
  • Confirm examples compile/run against a live Firecrawl instance

Generated by Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

One canonical quickstart per language (Node.js, Python, Rust, Java, Elixir)
covering search, scrape, and interact endpoints with complete parameter
references generated from SDK source and OpenAPI spec.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01S5eo8gmHCHoSokvJbTbqqY
@mintlify

mintlify Bot commented Aug 3, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
firecrawl 🟢 Ready View Preview Aug 3, 2026, 1:20 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Register the 5 new agent-quickstart pages in the "Build with AI" tab
navigation so they appear in the docs sidebar.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01S5eo8gmHCHoSokvJbTbqqY
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.

2 participants