Skip to content

docs(agent-quickstart): add canonical agent quickstart docs for 5 SDK languages - #1189

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

docs(agent-quickstart): add canonical agent quickstart docs for 5 SDK languages#1189
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-u6tgua

Conversation

@ericciarla

@ericciarla ericciarla commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add agent-quickstart/ directory with one canonical quickstart file per SDK language: Node.js, Python, Rust, Java, and Elixir
  • Each file covers search, scrape, and interact endpoints with install, auth, method signatures, realistic examples, and every confirmed parameter with descriptions
  • Generated from SDK source code and v2 OpenAPI spec as primary sources of truth

Details

These quickstart files are designed to be pasted into external agent context windows. Each file follows a consistent structure:

Language Package Version File
Node.js/TypeScript firecrawl 4.32.0 agent-quickstart/node.mdx
Python firecrawl-py latest agent-quickstart/python.mdx
Rust firecrawl (crate) 2.12.1 agent-quickstart/rust.mdx
Java firecrawl-java 1.12.1 agent-quickstart/java.mdx
Elixir firecrawl (hex) 1.9.1 agent-quickstart/elixir.mdx

Key language-specific differences documented:

  • Node.js, Python, Rust: interact supports both code and prompt parameters
  • Java, Elixir: interact supports code only (no prompt parameter)
  • Elixir: Auto-generated from OpenAPI, uses keyword lists, no client struct
  • Java: Builder pattern for all options, List<Map<String, Object>> for search results
  • Rust: Async-only, impl Into<Option<T>> pattern for optional params

Test plan

  • Verify each .mdx file renders cleanly as a Mintlify docs page
  • Cross-reference parameter lists against latest SDK source
  • Confirm examples compile/run against current SDK versions
  • Verify no navigation breakage (files are not yet added to docs.json)

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.

… languages

Add one quickstart file per SDK language (Node.js, Python, Rust, Java, Elixir) covering search, scrape, and interact endpoints. Each file includes install, auth, method signatures, realistic examples, and every confirmed parameter with descriptions. Generated from SDK source and v2 OpenAPI spec.

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

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