Quote a site crawl
web_access_sitemap_quoteQuote an asynchronous same-domain crawl of authorized public pages to estimate cost and discover pages for audits or coverage checks; no crawl runs until approval.
Instructions
Quote an asynchronous crawl of authorized public pages on one website. Nothing is crawled or billed: the quote creates a job that waits for approval. Starting from one URL, the crawler follows same-domain links breadth-first and can also seed from the site's /sitemap.xml. Requests must comply with destination policy, robots directives, rate limits, and access controls.
Use it to discover pages for site audits, authorized retrieval worklists, or coverage checks before fetching individual pages. Not for: reading one page's content (use web_access_fetch) or open-ended web queries (use web_access_search).
Requires url. Optional: maxPages (1–10000, default 10), maxDepth (1–100, default 2), pathPrefix (only crawl URLs whose path starts with this, e.g. "/docs"), budgetUsd (spend ceiling; the crawl stops with status token_cap_exceeded if it would exceed it), useSitemap (also seed the site's root /sitemap.xml — one extra billed page, but finds pages links miss).
{ "url": "https://example.com", "maxPages": 200, "maxDepth": 3 }Returns: jobId, estimatedPages, and estimatedCostUsd, with status awaiting_approval. A 403 means the target domain is blocked for this account; contact String support.
Next: show the user estimatedCostUsd. Only once they approve that cost, call web_access_sitemap_start with the jobId.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"url": "<url>"
},
"name": "web_access_sitemap_quote"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The full http(s) URL to start crawling from. The crawl stays on this URL's domain. | |
| maxDepth | No | Maximum link depth from the start URL, 1-100 (server default 2). | |
| maxPages | No | Maximum pages to fetch, 1-10000 (server default 10). Each fetched page is billed once the crawl starts. | |
| budgetUsd | No | Spend ceiling in USD (min 0.0001). The crawl finalizes as token_cap_exceeded when it would exceed this; omit to let the approved quote be the cap. | |
| pathPrefix | No | Restrict the crawl to URLs whose path starts with this prefix, e.g. '/docs'. | |
| useSitemap | No | Also seed the crawl from the site's root /sitemap.xml (one extra billed page; finds pages that internal links miss). |