Skip to content

docs: add agent quickstart files for all SDK languages - #1201

Draft
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-3ts7ms
Draft

docs: add agent quickstart files for all SDK languages#1201
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-3ts7ms

Conversation

@ericciarla

@ericciarla ericciarla commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add per-language agent quickstart documents in agent-quickstart/ covering the three core endpoints: search, scrape, and interact
  • Files for Node.js, Python, Rust, Java, and Elixir
  • Each file includes: install, auth, endpoint explanations, realistic examples, every confirmed parameter with descriptions, language-specific notes, and deprecated alias migration notes
  • Generated from SDK source code and the v2 OpenAPI spec (v2-openapi.json), with existing agent-source-of-truth/ docs as secondary reference

New files

File SDK version Notes
agent-quickstart/node.mdx firecrawl v4.32.0 Supports code and prompt on interact
agent-quickstart/python.mdx firecrawl-py v4.22.1 Supports code and prompt on interact
agent-quickstart/rust.mdx firecrawl crate v2.12.1 Supports code and prompt on interact
agent-quickstart/java.mdx firecrawl-java v1.12.1 Code-based interact only (no prompt)
agent-quickstart/elixir.mdx firecrawl hex v1.9.1 Code-based interact only (no prompt)

Design decisions

  • Follows the same pattern as agent-source-of-truth/ — not added to docs.json sidebar navigation since these are meant to be pasted into agent context, not browsed in the sidebar
  • One minimal-but-realistic example per endpoint (vs the source-of-truth files which have simple + complex examples)
  • Covers only search, scrape, and interact (no ask/docs-search sections)
  • Documents every confirmed parameter from SDK source with concise descriptions
  • Notes where Java and Elixir SDKs lack prompt support on interact

Test plan

  • Verify each .mdx file renders correctly in Mintlify
  • Cross-check parameter lists against latest SDK source
  • Confirm examples are syntactically valid

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.

Add per-language agent quickstart documents covering search, scrape, and
interact endpoints with confirmed parameters from SDK source and the v2
OpenAPI spec. Files for Node.js, Python, Rust, Java, and Elixir.

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

mintlify Bot commented Aug 4, 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 4, 2026, 1:23 PM

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

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