Skip to content

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

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds one canonical agent quickstart document per SDK language in agent-quickstart/:
    • node.mdx — JS/TS SDK v4.41.0
    • python.mdx — Python SDK v4.44.0
    • rust.mdx — Rust SDK v2.21.0
    • java.mdx — Java SDK v1.18.0
    • elixir.mdx — Elixir SDK v1.11.0
  • Each file covers search, scrape, and interact with confirmed parameters, working examples, and language-specific notes
  • Generated from SDK source as primary authority, cross-referenced with the v2 OpenAPI spec
  • Follows the required quickstart structure: install, authenticate, when-to-use-what, endpoint sections with parameters, notes, and source-of-truth references

Details

These files are designed to be pasted directly into agent context as the canonical reference for using Firecrawl's three core endpoints. Key differences from the existing agent-source-of-truth/ directory:

  • Quickstart-focused: simpler structure, one example per endpoint, flat parameter tables
  • Up-to-date SDK versions: reflects latest SDK source including new parameters like lockdown, domainTools, toolDetail, threatProtection, auditMetadata, includeDomains/excludeDomains
  • Language-specific accuracy: documents prompt support on interact only where the SDK actually exposes it (JS, Python, Rust — not Java or Elixir)
  • Mintlify-compatible MDX: valid YAML frontmatter, standard Markdown headings, fenced code blocks, no custom components

Test plan

  • Verify each .mdx file renders cleanly as a Mintlify docs page
  • Confirm parameter lists match current SDK source
  • Validate code examples compile/run against the listed SDK versions

🤖 Generated with Claude Code

https://claude.ai/code/session_01XyF46EHnn2GAewQjxb12LU


Generated by Claude Code

Add one canonical quickstart per SDK language in agent-quickstart/:
- node.mdx (JS/TS SDK v4.41.0)
- python.mdx (Python SDK v4.44.0)
- rust.mdx (Rust SDK v2.21.0)
- java.mdx (Java SDK v1.18.0)
- elixir.mdx (Elixir SDK v1.11.0)

Each file covers search, scrape, and interact with confirmed
parameters, working examples, and language-specific notes.
Generated from SDK source as primary authority, cross-referenced
with the v2 OpenAPI spec.

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

mintlify Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Sep 24, 2026, 1:21 PM

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

Copy link
Copy Markdown
Contributor Author

The failing check "Locale literals and extraction-hostile markdown" is a pre-existing issue on the base branch — the last 5 consecutive runs of the "Docs checks" workflow (runs #124–#128, across multiple unrelated PRs) all fail with the same errors in es/, fr/, and pt-BR/ locale files using translated API identifiers. This PR only adds files under agent-quickstart/ and does not touch any localized content.


Generated by Claude Code

This branch was successfully deployed

1 active deployment
staging — 53020dec Deployed Sep 24, 2026 by mintlify[bot]
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