Skip to content

Web scraping in Claude Code

Add the Spicrawl MCP server to Claude Code. Claude can then read web pages as clean Markdown.

Set it up

Three steps give Claude Code the tools, the know-how to write Spicrawl code, and rules for using both. Or do all three with spicrawl init --client claude.

  1. Set your API key:

    bash
    export SPICRAWL_API_KEY=spicrawl_live_...   # add to your shell profile
  2. Add the MCP server. Your shell fills in the key, and Claude Code stores it in ~/.claude.json, outside the repository. Add --scope user to use it in every project.

    bash
    claude mcp add --transport http spicrawl https://mcp.spicrawl.com/mcp \
      --header "Authorization: Bearer $SPICRAWL_API_KEY"

    For a team, commit .mcp.json at the project root instead. Claude Code reads each person’s own key from their environment:

    .mcp.json
    {
      "mcpServers": {
        "spicrawl": {
          "type": "http",
          "url": "https://mcp.spicrawl.com/mcp",
          "headers": { "Authorization": "Bearer ${SPICRAWL_API_KEY}" }
        }
      }
    }
  3. Install the skill. Claude loads it when a task involves web data, or when you type /spicrawl:

    bash
    mkdir -p .claude/skills/spicrawl
    curl -fsSL https://app.spicrawl.com/skill.md -o .claude/skills/spicrawl/SKILL.md
  4. Paste this section into CLAUDE.md at the project root:

    CLAUDE.md
    ## Web data (Spicrawl)
    
    Use Spicrawl to read web pages: the spicrawl_* MCP tools in chat, or
    POST https://api.spicrawl.com/v1/scrape with `Authorization: Bearer $SPICRAWL_API_KEY` in code.
    Docs: https://docs.spicrawl.com/llms.txt (append .md to any page URL for Markdown).
    
    - Ask for markdown: `response_format: "markdown"` (API default is html); on spicrawl_scrape, `format: "markdown"`.
    - Check the site's status, not only the HTTP status: `X-Target-Status` header, or `status`
      in the JSON envelope (spicrawl_scrape with `format: "json"`). 200 is the page; 404/410
      mean it does not exist; 403/429/503 mean the site refused, so escalate.
    - On an error, switch on `code`. Retry only when `retryable` is true, after
      `retry_after_seconds`. Read `diagnostics.hint` and change what it names first.
      Never retry ERR::REQUEST::*, ERR::AUTH::* or ERR::LIMIT::QUOTA_EXCEEDED.
    - Escalate one step at a time and stop at the first that works:
      plain fetch (1 credit) -> `js_render: true` (3) -> add the user's own `proxy`
      if they have one. Empty or skeleton content means render; ERR::UPSTREAM::CHALLENGE
      or a 403 target status means retry once, then the user's own proxy.
    - Set `max_cost` on every request to the price of the step you intend.
    - Keep the cache on (default). Set `cache: false` only for prices, stock or other live data.
    - Trim tokens with `main_content_only` (on by default for markdown), `include_tags`, `exclude_tags`.
    - For more than 20 URLs, use a batch job (spicrawl_batch_submit / POST /v1/batch).
      Batch items return html, markdown or text (spicrawl_batch_submit defaults to markdown,
      POST /v1/batch to html). Extraction, screenshots, actions and sessions are refused
      with a 400 before anything is charged: scrape those URLs one by one.
    - Never print or commit SPICRAWL_API_KEY. Log `X-Request-Id` for failures.
  5. Check it with claude mcp list, or /mcp in a session. You should see 25 spicrawl_* tools.

Prefer a plugin? It bundles the MCP server and the skill, so you can skip steps 2 and 3. Claude Code asks for your key when you enable it:

bash
claude plugin marketplace add OfficialSpicrawl/agent-plugins
claude plugin install spicrawl@spicrawl-plugins

A first task to try

Start claude in the project and ask:

prompt
Use Spicrawl to read https://example.com/pricing as markdown. List each plan with its monthly price.
If the page comes back empty, retry with rendering. Tell me how many credits it cost.

Claude calls spicrawl_scrape. To report the cost it needs format: "json", because that envelope carries credits. A full walkthrough is in how to scrape a website with Claude Code.

What it can do

The server gives the agent 25 spicrawl_* tools. Each call runs under your API key, with the same limits and credits as a direct API call.

  • Read one page: spicrawl_scrape returns Markdown (the default), text, HTML, JSON or PDF.
  • Read many pages: spicrawl_batch_submit queues up to 10,000 URLs. Follow it with spicrawl_batch_status and spicrawl_batch_results.
  • Pages behind a login: spicrawl_session_create keeps cookies and storage across calls.
  • Debug a failure: spicrawl_requests_list and spicrawl_request_get.
  • Check usage: spicrawl_usage_summary and the other usage tools. These need a key with the read scope.
  • Look things up: spicrawl_docs_search and spicrawl_docs_read search and read the Spicrawl docs.

One tool, spicrawl_browser_connect_url, is listed but coming soon. On spicrawl_scrape, the rendering argument is render, not the API’s js_render.

Good to know

  • No crawling. Spicrawl does not follow links or find pages. Give the agent the URLs.
  • Credits per request. A plain fetch is 1 credit. JavaScript rendering is 3. Full-browser rendering is 8.
  • Failures are free. A failed request costs 0 credits.
  • The cache saves time, not credits. A cache hit costs the same as the fetch that stored it.
  • Cap each call. Set max_cost, and a request that could cost more is refused before it runs.
  • Coming soon: managed proxies, stealth mode, a remote browser and AI extraction from a plain-language prompt. Today you can bring your own proxy.

Frequently asked questions

How do I add Spicrawl to Claude Code?

Export SPICRAWL_API_KEY, then run claude mcp add --transport http spicrawl https://mcp.spicrawl.com/mcp --header "Authorization: Bearer $SPICRAWL_API_KEY". Check it with claude mcp list.

How do I share the setup with my team?

Commit .mcp.json at the project root with the header "Bearer ${SPICRAWL_API_KEY}". Claude Code fills in each person’s own key from their environment when it starts.

Is there a Claude Code plugin?

Yes. Run claude plugin marketplace add OfficialSpicrawl/agent-plugins, then claude plugin install spicrawl@spicrawl-plugins. It bundles the MCP server and the skill, and asks for your key when you enable it.

Why does Claude get an "unknown argument" error for js_render?

On the spicrawl_scrape tool the argument is called render. js_render is the name in the HTTP API.

How much does each page cost?

A plain fetch costs 1 credit, JavaScript rendering 3 and full-browser rendering 8. Failed requests cost 0. A cache hit costs the same as the fetch that stored it. Ask the agent to set max_cost on each request so it never spends more than you expect.