Skip to content

Add agent quickstart docs for all SDK languages - #1299

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

Add agent quickstart docs for all SDK languages#1299
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-3bepuq

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds one canonical agent quickstart file per SDK language in agent-quickstart/: Node.js, Python, Rust, Java, and Elixir
  • Each file covers the three core endpoints: search, scrape, and interact
  • Every file includes: install instructions, auth patterns, "when to use what" guide, preferred SDK method names, working examples, complete parameter tables with descriptions and defaults, deprecated alias migration notes, and language-specific caveats
  • All content sourced from SDK source code (primary) and the OpenAPI spec (secondary) — no invented parameters or defaults

Details

Each quickstart follows a consistent structure:

  1. Install / Authenticate
  2. When To Use What (search vs scrape vs interact)
  3. Per-endpoint sections with why, method name, example, and full parameter table
  4. Notes on language-specific conventions (naming, patterns, deprecated aliases)
  5. Source of truth references

Language-specific highlights:

  • Node.js: Documents Zod schema integration for type-safe JSON extraction, camelCase conventions
  • Python: Documents snake_case parameter naming, SearchData migration (.web/.news/.images instead of .data)
  • Rust: Documents struct update syntax with Default, impl AsRef<str> ergonomics, async/Tokio requirement
  • Java: Documents builder pattern, method overloading for defaults, CompletableFuture async variants
  • Elixir: Documents auto-generated OpenAPI function names, keyword list params, atom enum values, bang variants

Notable cross-language differences documented:

  • prompt parameter for interact is available in Node.js, Python, and Rust but not in Java or Elixir
  • Search limit default varies: 5 (Python), 10 (OpenAPI/Node.js/Java), 20 max (Rust)
  • Elixir function names follow OpenAPI operation IDs (scrape_and_extract_from_url vs scrape)

Test plan

  • Verify each .mdx file renders cleanly as a Mintlify docs page
  • Confirm parameter tables match current SDK source
  • Check code examples for syntax correctness
  • Validate frontmatter fields

Generated by Claude Code

One canonical quickstart file per SDK language (Node.js, Python, Rust,
Java, Elixir) covering search, scrape, and interact endpoints. Each file
includes install instructions, auth patterns, method signatures, working
examples, and complete parameter tables sourced from SDK code and the
OpenAPI spec.

Co-Authored-By: Claude <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 21, 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 21, 2026, 4:12 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