Supercharge your AI agents with data from the web and beyond. Building the library for superintelligence. 🔥
TypeScript aiai-agentsai-crawlerai-scrapingai-searchcrawlerdata-extractionhtml-to-markdownllmmarkdownscraperscrapingweb-crawlerweb-dataweb-data-extractionweb-scraperweb-scrapingweb-searchwebscraping
Add compact tool discovery and default search to compact (#4705)
Developers Digest4e35739f830e
diff --git a/apps/api/src/controllers/v2/search-schema.test.ts b/apps/api/src/controllers/v2/search-schema.test.tsindex 769c48c30..bd30c2c05 100644--- a/apps/api/src/controllers/v2/search-schema.test.ts+++ b/apps/api/src/controllers/v2/search-schema.test.ts@@ -1,12 +1,22 @@import { describe, expect, it } from "vitest";-import { searchRequestSchema } from "./types";+import { searchRequestSchema, scrapeRequestSchema } from "./types";describe("searchRequestSchema highlights", () => {- it.each(["summary", "full"])("accepts %s tool detail", toolDetail => {- expect(- searchRequestSchema.parse({ query: "records", toolDetail }).toolDetail,- ).toBe(toolDetail);- });+ it.each(["compact", "summary", "full"])(+ "accepts %s tool detail",+ toolDetail => {+ expect(+ searchRequestSchema.parse({ query: "records", toolDetail }).toolDetail,+ ).toBe(toolDetail);+ expect(+ scrapeRequestSchema.parse({+ url: "https://example.com",+ domainTools: true,+ toolDetail,+ }).toolDetail,+ ).toBe(toolDetail);+ },+ );it("rejects unknown tool detail", () => {expect(searchRequestSchema.safeParse({ query: "records", toolDetail: "all" })@@ -17,6 +27,10 @@ describe("searchRequestSchema highlights", () => {const request = searchRequestSchema.parse({ query: "firecrawl" });expect(request.highlights).toBeUndefined();+ expect(request.toolDetail).toBe("compact");+ expect(+ scrapeRequestSchema.parse({ url: "https://example.com" }).toolDetail,+ ).toBeUndefined();});it("allows highlights to be enabled explicitly", () => {diff --git a/apps/api/src/controllers/v2/types.ts b/apps/api/src/controllers/v2/types.tsindex cc4e49ae1..29e1bafff 100644--- a/apps/api/src/controllers/v2/types.ts+++ b/apps/api/src/controllers/v2/types.ts@@ -1131,7 +1131,7 @@ const scrapeRequestSchemaBase = baseScrapeOptions.extend({integration: integrationSchema.optional().transform(val => val || null),zeroDataRetention: z.boolean().optional(),domainTools: z.boolean().optional(),- toolDetail: z.enum(["summary", "full"]).optional(),+ toolDetail: z.enum(["compact", "summary", "full"]).optional(),__agentInterop: z.object({auth: z.string(),@@ -2411,7 +2411,7 @@ export const searchRequestSchema = z// whether generated highlights are returned or only run in shadow mode.highlights: z.boolean().optional(),domainTools: z.boolean().optional(),- toolDetail: z.enum(["summary", "full"]).optional(),+ toolDetail: z.enum(["compact", "summary", "full"]).prefault("compact"),__searchPreviewToken: z.string().optional(),threatProtection: threatProtectionOverrideSchema.optional(),scrapeOptions: baseScrapeOptionsdiff --git a/apps/api/src/search/alexandria.test.ts b/apps/api/src/search/alexandria.test.tsindex fc5014ec4..e03008dcb 100644--- a/apps/api/src/search/alexandria.test.ts+++ b/apps/api/src/search/alexandria.test.ts@@ -25,9 +25,14 @@ const tool = {example: { query: "test" },next,};+const compact = {+ provider: tool.provider,+ capability: tool.capability,+ description: tool.description,+};const input = { teamId: "team", query: "records", limit: 5, timeoutMs: 10000 };beforeEach(() => vi.clearAllMocks());-it.each([undefined, "summary", "full"] as const)(+it.each([undefined, "compact", "summary", "full"] as const)("supports %s discovery detail",async toolDetail => {request.mockResolvedValue({@@ -45,6 +50,10 @@ it.each([undefined, "summary", "full"] as const)(toolDetail === "full" ? ["options", "response", "examples"] : [],},});+ if (toolDetail === "compact") {+ expect(result.items).toEqual([compact]);+ return;+ }expect(result.items[0]).toMatchObject({id: "sample/records/search",matchedBy: ["semantic"],@@ -67,7 +76,7 @@ it("keeps a warning when discovery fails", async () => {expect(result.items).toEqual([]);expect(result.warning).toBeTruthy();});-it.each([undefined, "full"] as const)(+it.each([undefined, "compact", "full"] as const)("deduplicates semantic and domain tools with %s detail",async toolDetail => {request.mockImplementation(async args =>@@ -94,6 +103,10 @@ it.each([undefined, "full"] as const)(logger,);expect(result.items).toHaveLength(1);+ if (toolDetail === "compact") {+ expect(result.items).toEqual([compact]);+ return;+ }expect(result.items[0]).toMatchObject({matchedBy: ["semantic", "domain"],matchedUrls: ["https://example.com/records"],@@ -140,7 +153,7 @@ it("keeps tools when optional navigation is absent, extended or malformed", asynconst result = await discoverTools(input, logger);expect(result.items).toHaveLength(3);expect(result.warning).toBeUndefined();- expect(result.items[1].next).toMatchObject({ ...next, label: "Inspect" });- expect(result.items[0].next).toBeUndefined();- expect(result.items[2].next).toBeUndefined();+ expect(result.items[1]).toHaveProperty("next", { ...next, label: "Inspect" });+ expect(result.items[0]).toMatchObject({ next: undefined });+ expect(result.items[2]).toMatchObject({ next: undefined });});diff --git a/apps/api/src/search/alexandria.ts b/apps/api/src/search/alexandria.tsindex dc1a30e37..40cbe6e26 100644--- a/apps/api/src/search/alexandria.ts+++ b/apps/api/src/search/alexandria.ts@@ -5,6 +5,7 @@ import {toolSchema,toolSummarySchema,type DiscoveredTool,+ type DetailedDiscoveredTool,} from "../services/alexandria/contracts";export const isAlexandriaSource = (source: { type: string }) =>@@ -37,7 +38,7 @@ export function isToolsOnlySearch(export async function discoverTools(input: {teamId: string;- toolDetail?: "summary" | "full";+ toolDetail?: "compact" | "summary" | "full";query?: string;urls?: string[];limit: number;@@ -46,7 +47,7 @@ export async function discoverTools(logger: Logger,): Promise<ToolDiscovery> {const deadline = Date.now() + Math.min(10000, input.timeoutMs);- const items = new Map<string, DiscoveredTool>();+ const items = new Map<string, DetailedDiscoveredTool>();const selected = { semantic: new Set<string>(), domain: new Set<string>() };let failed = false;const remaining = () => {@@ -210,7 +211,15 @@ export async function discoverTools(}}return {- items: [...items.values()],+ items: [...items.values()].map(tool =>+ input.toolDetail === "compact"+ ? {+ provider: tool.provider,+ capability: tool.capability,+ description: tool.description,+ }+ : tool,+ ),...(failed? { warning: "Some tool discovery results are unavailable." }: {}),diff --git a/apps/api/src/search/execute.ts b/apps/api/src/search/execute.tsindex 2e14eae95..07ded9c54 100644--- a/apps/api/src/search/execute.ts+++ b/apps/api/src/search/execute.ts@@ -45,7 +45,7 @@ interface SearchOptions {scrapeOptions?: ScrapeOptions;highlights?: boolean;domainTools?: boolean;- toolDetail?: "summary" | "full";+ toolDetail?: "compact" | "summary" | "full";timeout: number;}@@ -253,7 +253,7 @@ export async function executeSearch() {const discovery = await discoverTools({- toolDetail: options.toolDetail,+ toolDetail: options.toolDetail ?? "compact",teamId,limit,query: wantsTools ? query : undefined,diff --git a/apps/api/src/services/alexandria/contracts.ts b/apps/api/src/services/alexandria/contracts.tsindex 61d1676b9..8f98ef66c 100644--- a/apps/api/src/services/alexandria/contracts.ts+++ b/apps/api/src/services/alexandria/contracts.ts@@ -77,7 +77,7 @@ export const toolSummarySchema = toolSchemarecordsPerUnit: z.number().positive().optional(),zeroDataRetentionCreditsCost: credits.optional(),});-export type DiscoveredTool = (+export type DetailedDiscoveredTool = (| z.infer<typeof toolSchema>| z.infer<typeof toolSummarySchema>) & {@@ -95,3 +95,9 @@ export const refusal = (status,body: { success: false, error, ...extra },});++export type CompactDiscoveredTool = Pick<+ z.infer<typeof toolSummarySchema>,+ "provider" | "capability" | "description"+>;+export type DiscoveredTool = CompactDiscoveredTool | DetailedDiscoveredTool;diff --git a/apps/js-sdk/firecrawl/package.json b/apps/js-sdk/firecrawl/package.jsonindex bfc519be6..696f1862d 100644--- a/apps/js-sdk/firecrawl/package.json+++ b/apps/js-sdk/firecrawl/package.json@@ -1,6 +1,6 @@{"name": "@mendable/firecrawl-js",- "version": "4.40.0",+ "version": "4.41.0","description": "JavaScript SDK for the Firecrawl API: web scraping, crawling, web search, and scientific literature search over a research paper index of PubMed, bioRxiv, medRxiv and arXiv abstracts","main": "dist/index.js","types": "dist/index.d.ts",diff --git a/apps/js-sdk/firecrawl/src/__tests__/unit/v2/extract.unit.test.ts b/apps/js-sdk/firecrawl/src/__tests__/unit/v2/extract.unit.test.tsindex 95be255e6..cd13f877c 100644--- a/apps/js-sdk/firecrawl/src/__tests__/unit/v2/extract.unit.test.ts+++ b/apps/js-sdk/firecrawl/src/__tests__/unit/v2/extract.unit.test.ts@@ -3,6 +3,29 @@ import { startExtract } from "../../../v2/methods/extract";import type { WebhookConfig } from "../../../v2/types";describe("v2.extract unit", () => {+ test("omits discovery options from extract without mutating shared options", async () => {+ const post = jest+ .fn()+ .mockResolvedValue({ status: 200, data: { id: "extract-job" } });+ const scrapeOptions = {+ toolDetail: "compact" as const,+ domainTools: true,+ onlyMainContent: true,+ };+ await startExtract({ post } as any, {+ urls: ["https://example.com"],+ scrapeOptions,+ });+ expect(post).toHaveBeenCalledWith("/v2/extract", {+ urls: ["https://example.com"],+ scrapeOptions: { onlyMainContent: true },+ });+ expect(scrapeOptions).toEqual({+ toolDetail: "compact",+ domainTools: true,+ onlyMainContent: true,+ });+ });test("startExtract forwards string webhook in request payload", async () => {const post = jest.fn().mockResolvedValue({status: 200,diff --git a/apps/js-sdk/firecrawl/src/__tests__/unit/v2/tools.unit.test.ts b/apps/js-sdk/firecrawl/src/__tests__/unit/v2/tools.unit.test.tsindex 7ee596903..9daed1b64 100644--- a/apps/js-sdk/firecrawl/src/__tests__/unit/v2/tools.unit.test.ts+++ b/apps/js-sdk/firecrawl/src/__tests__/unit/v2/tools.unit.test.ts@@ -1,4 +1,12 @@-import { afterAll, beforeAll, beforeEach, describe, expect, jest, test } from "@jest/globals";+import {+ afterAll,+ beforeAll,+ beforeEach,+ describe,+ expect,+ jest,+ test,+} from "@jest/globals";import { createServer, type Server } from "node:http";import { FirecrawlClient } from "../../../v2/client";@@ -52,6 +60,13 @@ const next = {capability: "find-tools",options: { providers: ["particle"], level: "tools" },};+const compactTools = [tool, productionTool].map(+ ({ provider, capability, description }) => ({+ provider,+ capability,+ description,+ }),+);let server: Server;let client: FirecrawlClient;const sent: Array<{ body: any; id: string | undefined }> = [];@@ -76,10 +91,20 @@ beforeAll(async () => {warning: "Example warning",data: {web: [{ url: "https://podcasts.apple.com" }],- tools: [tool, productionTool],+ tools:+ body.toolDetail === "compact"+ ? compactTools+ : [tool, productionTool],},}),);+ if (req.url === "/v2/scrape" && body.url)+ return res.end(+ JSON.stringify({+ success: true,+ data: { markdown: "Example", tools: compactTools },+ }),+ );if (body.alexandria[0].provider === "retry" && attempts++ === 0) {res.statusCode = 502;return res.end("{}");@@ -150,9 +175,25 @@ afterAll(async () => {});describe("Alexandria contracts and execution", () => {- test.each(["summary", "full"] as const)("forwards %s discovery detail", async toolDetail => {- await client.search("records", { toolDetail });- expect(sent.at(-1)?.body).toMatchObject({ toolDetail });+ test.each(["compact", "summary", "full"] as const)(+ "forwards %s discovery detail",+ async (toolDetail) => {+ const result = await client.search("records", { toolDetail });+ if (toolDetail === "compact") expect(result.tools).toEqual(compactTools);+ expect(sent.at(-1)?.body).toMatchObject({ toolDetail });+ },+ );+ test("URL scrape forwards compact detail and preserves tools", async () => {+ const result = await client.scrape("https://example.com", {+ domainTools: true,+ toolDetail: "compact",+ });+ expect(sent.at(-1)?.body).toMatchObject({+ url: "https://example.com",+ domainTools: true,+ toolDetail: "compact",+ });+ expect(result.tools).toEqual(compactTools);});test("returns complete unified tools and warning beside web results", async () => {const result = await client.search("podcasts", {@@ -230,15 +271,27 @@ describe("Alexandria contracts and execution", () => {});});--test.each([[undefined, 80000], [1000, 31000], [100000, 80000]])(+test.each([+ [undefined, 80000],+ [1000, 31000],+ [100000, 80000],+])("Alexandria timeout %s allows response delivery (%s ms)",async (timeout, timeoutMs) => {- const http = { post: jest.fn(async () => ({ status: 200, data: {- success: true, data: { alexandria: [], creditsCost: 0 },- } })) };+ const http = {+ post: jest.fn(async () => ({+ status: 200,+ data: {+ success: true,+ data: { alexandria: [], creditsCost: 0 },+ },+ })),+ };await scrapeAlexandria(http as any, [next], { timeout });- expect(http.post).toHaveBeenCalledWith("/v2/scrape", expect.anything(),- expect.objectContaining({ timeoutMs }));+ expect(http.post).toHaveBeenCalledWith(+ "/v2/scrape",+ expect.anything(),+ expect.objectContaining({ timeoutMs }),+ );},);diff --git a/apps/js-sdk/firecrawl/src/v2/methods/extract.ts b/apps/js-sdk/firecrawl/src/v2/methods/extract.tsindex 84a11e610..51d4e7da6 100644--- a/apps/js-sdk/firecrawl/src/v2/methods/extract.ts+++ b/apps/js-sdk/firecrawl/src/v2/methods/extract.ts@@ -40,7 +40,8 @@ function prepareExtractPayload(args: {body.threatProtection = args.threatProtection;if (args.scrapeOptions) {ensureValidScrapeOptions(args.scrapeOptions);- body.scrapeOptions = args.scrapeOptions;+ const { toolDetail, domainTools, ...scrapeOptions } = args.scrapeOptions;+ body.scrapeOptions = scrapeOptions;}return body;}diff --git a/apps/js-sdk/firecrawl/src/v2/types.ts b/apps/js-sdk/firecrawl/src/v2/types.tsindex 736f62917..3a34094e8 100644--- a/apps/js-sdk/firecrawl/src/v2/types.ts+++ b/apps/js-sdk/firecrawl/src/v2/types.ts@@ -287,8 +287,8 @@ export interface ScrapeOptions {origin?: string;/** Include domain-matched Alexandria tools for this URL in `tools`. Default off. */domainTools?: boolean;- /** Tool summaries by default; full includes input/output contracts. */- toolDetail?: "summary" | "full";+ /** Summary by default; compact returns identity and description, full includes contracts. */+ toolDetail?: "compact" | "summary" | "full";}export type RedactPIIEntity =@@ -833,10 +833,10 @@ export interface DiscoveredTool {id?: string;provider: string;capability: string;- name: string;+ name?: string;description: string;- creditsCost: number;- perRecord: boolean;+ creditsCost?: number;+ perRecord?: boolean;options?: Array<{name: string;type: string;@@ -976,8 +976,8 @@ export interface SearchRequest {query: string;/** Include domain-matched tools in tools alongside semantic matches. */domainTools?: boolean;- /** Tool summaries by default; full includes input/output contracts. */- toolDetail?: "summary" | "full";+ /** Compact by default; summary adds metadata, full includes contracts. */+ toolDetail?: "compact" | "summary" | "full";sources?: Array<"web" | "news" | "images" | "alexandria"| { type: "web" | "news" | "images" | "alexandria" }diff --git a/apps/python-sdk/firecrawl/__init__.py b/apps/python-sdk/firecrawl/__init__.pyindex 991cb708a..8c39be08e 100644--- a/apps/python-sdk/firecrawl/__init__.py+++ b/apps/python-sdk/firecrawl/__init__.py@@ -27,7 +27,7 @@ from .v1 import (V1ChangeTrackingOptions,)-__version__ = "4.43.0"+__version__ = "4.44.0"# Define the logger for the Firecrawl projectlogger: logging.Logger = logging.getLogger("firecrawl")diff --git a/apps/python-sdk/firecrawl/__tests__/unit/v2/methods/test_tools.py b/apps/python-sdk/firecrawl/__tests__/unit/v2/methods/test_tools.pyindex ca0e22c9b..2627a05f3 100644--- a/apps/python-sdk/firecrawl/__tests__/unit/v2/methods/test_tools.py+++ b/apps/python-sdk/firecrawl/__tests__/unit/v2/methods/test_tools.py@@ -212,7 +212,7 @@ async def test_alexandria_transport_timeout(async_client, timeout, expected):payload = client.post.call_args.args[1]assert payload.get("timeout") == timeout[email protected]('detail', ['summary', 'full'])[email protected]('detail', ['compact', 'summary', 'full'])def test_discovery_detail_serialization(detail):from firecrawl.v2.types import ScrapeOptions, SearchRequest, DiscoveredToolfrom firecrawl.v2.utils.validation import prepare_scrape_options@@ -222,3 +222,10 @@ def test_discovery_detail_serialization(detail):summary = {key:value for key,value in TOOL.items() if key not in ('options','response','examples')}summary['next'] = NEXTassert DiscoveredTool(**summary).next == NEXT+++def test_compact_discovery_response_parsing():+ from firecrawl.v2.types import SearchData, Document+ compact = {"provider": "sample", "capability": "records/search", "description": "Search records"}+ for parsed in [SearchData(tools=[compact]), Document(tools=[compact])]:+ assert parsed.tools[0].model_dump(by_alias=True, exclude_unset=True) == compactdiff --git a/apps/python-sdk/firecrawl/v2/client.py b/apps/python-sdk/firecrawl/v2/client.pyindex f1904d3c0..b95f844e7 100644--- a/apps/python-sdk/firecrawl/v2/client.py+++ b/apps/python-sdk/firecrawl/v2/client.py@@ -184,7 +184,7 @@ class FirecrawlClient:audit_metadata: Optional[AuditMetadata] = None,integration: Optional[str] = None,domain_tools: Optional[bool] = None,- tool_detail: Optional[Literal["summary", "full"]] = None,+ tool_detail: Optional[Literal["compact", "summary", "full"]] = None,) -> Union[Document, AlexandriaScrapeData]:"""Scrape a single URL and return the document.@@ -212,7 +212,7 @@ class FirecrawlClient:lockdown: Serve only previously cached results; never make outbound requests. Returns 404 SCRAPE_LOCKDOWN_CACHE_MISS on cache miss.threat_protection: Enterprise per-request override of the team's threat protection policyprofile: Browser profile for persistent state (e.g. {"name": "my-profile", "saveChanges": True})- tool_detail: "summary" (default) returns compact tool summaries; "full" includes contracts when domain discovery is enabled.+ tool_detail: "compact" returns provider, capability and description; "summary" (default) adds metadata; "full" includes contracts when domain discovery is enabled.audit_metadata: Metadata to include in SIEM logging eventsReturns:Document@@ -471,7 +471,7 @@ class FirecrawlClient:*,sources: Optional[List[SourceOption]] = None,domain_tools: Optional[bool] = None,- tool_detail: Optional[Literal["summary", "full"]] = None,+ tool_detail: Optional[Literal["compact", "summary", "full"]] = None,categories: Optional[List[CategoryOption]] = None,include_domains: Optional[List[str]] = None,exclude_domains: Optional[List[str]] = None,@@ -492,7 +492,7 @@ class FirecrawlClient:Args:query: Search query string- tool_detail: "summary" (default) returns compact tool summaries with a follow-up request; "full" includes contracts immediately.+ tool_detail: "compact" (default) returns provider, capability and description; "summary" adds metadata and a follow-up request; "full" includes contracts.limit: Maximum number of results to return (default: 5)tbs: Time-based search filterlocation: Location string for searchdiff --git a/apps/python-sdk/firecrawl/v2/types.py b/apps/python-sdk/firecrawl/v2/types.pyindex cd02c6084..8c29260fe 100644--- a/apps/python-sdk/firecrawl/v2/types.py+++ b/apps/python-sdk/firecrawl/v2/types.py@@ -929,7 +929,7 @@ class ScrapeOptions(BaseModel):# Enables Alexandria domain-tool discovery/execution for this scrape.# Omitted from the serialized request entirely when unset or False.domain_tools: Optional[bool] = Field(default=None, alias="domainTools")- tool_detail: Optional[Literal["summary", "full"]] = Field(default=None, alias="toolDetail")+ tool_detail: Optional[Literal["compact", "summary", "full"]] = Field(default=None, alias="toolDetail")model_config = {"populate_by_name": True}@@ -1070,11 +1070,11 @@ class ExchangeSearchResult(BaseModel):class DiscoveredTool(ExchangeSearchResult):next: Optional[Dict[str, Any]] = None- credits_cost: int = Field(alias="creditsCost")+ credits_cost: Optional[int] = Field(default=None, alias="creditsCost")id: Optional[str] = None- name: str+ name: Optional[str] = Nonedescription: str- per_record: bool = Field(alias="perRecord")+ per_record: Optional[bool] = Field(default=None, alias="perRecord")options: List[Dict[str, Any]] = Field(default_factory=list)requires_one_of: Optional[List[List[str]]] = Field(default=None, alias="requiresOneOf")response: Dict[str, Any] = Field(default_factory=dict)@@ -2270,7 +2270,7 @@ class SearchRequest(BaseModel):query: strdomain_tools: Optional[bool] = Field(default=None, alias="domainTools")- tool_detail: Optional[Literal["summary", "full"]] = Field(default=None, alias="toolDetail")+ tool_detail: Optional[Literal["compact", "summary", "full"]] = Field(default=None, alias="toolDetail")sources: Optional[List[SourceOption]] = Nonecategories: Optional[List[CategoryOption]] = Noneinclude_domains: Optional[List[str]] = Nonediff --git a/apps/rust-sdk/Cargo.lock b/apps/rust-sdk/Cargo.lockindex 7b333adb1..f18f3652b 100644--- a/apps/rust-sdk/Cargo.lock+++ b/apps/rust-sdk/Cargo.lock@@ -250,7 +250,7 @@ checksum = "37909eebbb50d72f9059c3b6d82c0463f2ff062c9e95845c43a6c9c0355411be"[[package]]name = "firecrawl"-version = "2.20.0"+version = "2.21.0"dependencies = ["mockito","reqwest",diff --git a/apps/rust-sdk/Cargo.toml b/apps/rust-sdk/Cargo.tomlindex 48e80db14..a32c81a5c 100644--- a/apps/rust-sdk/Cargo.toml+++ b/apps/rust-sdk/Cargo.toml@@ -1,6 +1,6 @@[package]name = "firecrawl"-version = "2.20.0"+version = "2.21.0"edition = "2021"license = "MIT"homepage = "https://www.firecrawl.dev/"diff --git a/apps/rust-sdk/src/scrape.rs b/apps/rust-sdk/src/scrape.rsindex 1b3d411b5..05891a660 100644--- a/apps/rust-sdk/src/scrape.rs+++ b/apps/rust-sdk/src/scrape.rs@@ -106,6 +106,9 @@ pub struct ScrapeOptions {/// Enable Alexandria domain-tool discovery for this scrape.pub domain_tools: Option<bool>,++ /// Discovery response detail; defaults to summary.+ pub tool_detail: Option<crate::types::ToolDetail>,}/// Parser configuration for document parsing.diff --git a/apps/rust-sdk/src/search.rs b/apps/rust-sdk/src/search.rsindex 1086f56a3..f7aca42d6 100644--- a/apps/rust-sdk/src/search.rs+++ b/apps/rust-sdk/src/search.rs@@ -24,6 +24,9 @@ pub struct SearchOptions {/// Enable Alexandria domain-tool discovery (send alongside `sources: ["alexandria"]`).pub domain_tools: Option<bool>,+ /// Discovery response detail; defaults to compact.+ pub tool_detail: Option<crate::types::ToolDetail>,+/// Categories to filter results (github, research, pdf).pub categories: Option<Vec<SearchCategory>>,diff --git a/apps/rust-sdk/src/types.rs b/apps/rust-sdk/src/types.rsindex c7c6e9720..dd14bf052 100644--- a/apps/rust-sdk/src/types.rs+++ b/apps/rust-sdk/src/types.rs@@ -1324,10 +1324,13 @@ pub struct DiscoveredTool {pub id: Option<String>,pub provider: String,pub capability: String,- pub name: String,+ #[serde(default, skip_serializing_if = "Option::is_none")]+ pub name: Option<String>,pub description: String,- pub credits_cost: u32,- pub per_record: bool,+ #[serde(default, skip_serializing_if = "Option::is_none")]+ pub credits_cost: Option<u32>,+ #[serde(default, skip_serializing_if = "Option::is_none")]+ pub per_record: Option<bool>,#[serde(default)]pub options: Vec<serde_json::Value>,#[serde(default, skip_serializing_if = "Option::is_none")]@@ -1361,3 +1364,11 @@ pub struct DiscoveredTool {#[serde(flatten)]pub extra: serde_json::Map<String, serde_json::Value>,}++#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]+#[serde(rename_all = "lowercase")]+pub enum ToolDetail {+ Compact,+ Summary,+ Full,+}diff --git a/apps/rust-sdk/tests/tools.rs b/apps/rust-sdk/tests/tools.rsindex 066dd65db..4a6ae96ab 100644--- a/apps/rust-sdk/tests/tools.rs+++ b/apps/rust-sdk/tests/tools.rs@@ -164,3 +164,28 @@ async fn unified_contracts_and_execution_identity() {}invalid.assert_async().await;}++#[test]+fn compact_discovery_models() {+ let compact = json!({"provider":"p","capability":"search","description":"Find records"});+ let tool: firecrawl::DiscoveredTool = serde_json::from_value(compact).unwrap();+ assert!(tool.name.is_none());+ assert!(tool.credits_cost.is_none());+ assert!(tool.per_record.is_none());+ let search = SearchOptions {+ tool_detail: Some(firecrawl::ToolDetail::Compact),+ ..Default::default()+ };+ assert_eq!(+ serde_json::to_value(search).unwrap()["toolDetail"],+ "compact"+ );+ let scrape = firecrawl::ScrapeOptions {+ tool_detail: Some(firecrawl::ToolDetail::Compact),+ ..Default::default()+ };+ assert_eq!(+ serde_json::to_value(scrape).unwrap()["toolDetail"],+ "compact"+ );+}