O Spicrawl agora funciona com OpenAI Agents SDK, LangChain, Codex, Claude Code e mais.Ver integrações
Pular para o conteúdo

Web scraping no Codex

Adicione o servidor MCP do Spicrawl ao Codex. Ele passa a ler páginas web como Markdown limpo.

Configure

Três passos dão ao Codex as ferramentas, o conhecimento para escrever código do Spicrawl e regras para usar os dois. Ou faça os três de uma vez com spicrawl init --client codex.

  1. Defina a sua chave de API:

    bash
    export SPICRAWL_API_KEY=spicrawl_live_...   # add to your shell profile
  2. Adicione o servidor MCP. O Codex lê a chave de SPICRAWL_API_KEY a cada conexão, então a chave nunca vai parar em um arquivo:

    bash
    codex mcp add spicrawl --url https://mcp.spicrawl.com/mcp --bearer-token-env-var SPICRAWL_API_KEY

    Isso grava o mesmo que esta configuração:

    ~/.codex/config.toml
    [mcp_servers.spicrawl]
    url = "https://mcp.spicrawl.com/mcp"
    bearer_token_env_var = "SPICRAWL_API_KEY"

    Para um único projeto, coloque a tabela em .codex/config.toml. O Codex só a lê em projetos confiáveis.

  3. Instale a skill:

    bash
    mkdir -p .agents/skills/spicrawl
    curl -fsSL https://app.spicrawl.com/skill.md -o .agents/skills/spicrawl/SKILL.md
  4. Cole esta seção em AGENTS.md na raiz do projeto:

    AGENTS.md
    ## Web data (Spicrawl)
    
    Use Spicrawl to read web pages: the spicrawl_* MCP tools, the `spicrawl` CLI, 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.
    - With the CLI, read stdout as JSON and branch on the exit code: 3 auth, 4 bad request,
      5 limit, 6 site refused or failed, 7 proxy, 8 engine or extraction, 10 network.
    - Never print or commit SPICRAWL_API_KEY. Log `X-Request-Id` for failures.
  5. Confira com codex mcp list, ou /mcp em uma sessão. Você deve ver 25 ferramentas spicrawl_*.

Ou use a CLI

O Codex trabalha em um shell, então a CLI spicrawl funciona sem nenhuma configuração. Ela imprime JSON quando usada em pipe e sai com um código estável:

bash
spicrawl scrape https://example.com/pricing --format markdown --max-cost 3 | jq -r .content

No Codex cloud, não conte com o servidor MCP. Use a CLI ou HTTP puro. Defina SPICRAWL_API_KEY como variável de ambiente, não como secret, e permita api.spicrawl.com no acesso do agente à internet.

Uma primeira tarefa para testar

Inicie codex no projeto e peça:

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.

O que ele pode fazer

O servidor dá ao agente 25 ferramentas spicrawl_*. Cada chamada roda sob a sua chave de API, com os mesmos limites e créditos de uma chamada direta à API.

  • Ler uma página: spicrawl_scrape retorna Markdown (o padrão), texto, HTML, JSON ou PDF.
  • Ler várias páginas: spicrawl_batch_submit enfileira até 10.000 URLs. Acompanhe com spicrawl_batch_status e spicrawl_batch_results.
  • Páginas atrás de um login: spicrawl_session_create mantém cookies e armazenamento entre as chamadas.
  • Depure uma falha: spicrawl_requests_list e spicrawl_request_get.
  • Verifique o uso: spicrawl_usage_summary e as outras ferramentas de uso. Elas exigem uma chave com o escopo read.
  • Pesquise coisas: spicrawl_docs_search e spicrawl_docs_read pesquisam e leem a documentação do Spicrawl.

Uma ferramenta, spicrawl_browser_connect_url, está listada mas chega em breve. Em spicrawl_scrape, o argumento de renderização é render, não o js_render da API.

Bom saber

  • Sem crawl. O Spicrawl não segue links nem encontra páginas. Dê as URLs ao agente.
  • Créditos por requisição. Um fetch simples custa 1 crédito. A renderização JavaScript custa 3. A renderização em navegador completo custa 8.
  • Falhas são grátis. Uma requisição que falha custa 0 crédito.
  • O cache economiza tempo, não créditos. Um acerto de cache custa o mesmo que a busca que o guardou.
  • Limite cada chamada. Defina max_cost e uma requisição que poderia custar mais é recusada antes de rodar.
  • Em breve: proxies gerenciados, modo stealth, um navegador remoto e extração com IA a partir de um prompt em linguagem natural. Hoje você pode usar seu próprio proxy.

Perguntas frequentes

Onde o Codex guarda o servidor?

Em ~/.codex/config.toml. Para usar em um único projeto, coloque a mesma tabela em .codex/config.toml. O Codex só lê a configuração de projeto em projetos confiáveis.

O Codex pode usar a CLI em vez do MCP?

Sim. O Codex trabalha em um shell, então pode rodar spicrawl scrape URL --format markdown --max-cost 3. A CLI imprime JSON quando recebe dados por pipe e sai com um código estável.

Funciona no Codex cloud?

Não conte com o servidor MCP nesse caso. Use a CLI ou HTTP simples. Defina SPICRAWL_API_KEY como variável de ambiente (não como segredo) e permita api.spicrawl.com no acesso à internet do agente.

Por que o servidor retorna 401?

SPICRAWL_API_KEY não estava definida no shell que iniciou o codex. Exporte-a e inicie uma nova sessão.

Quanto custa cada página?

Um fetch simples custa 1 crédito, a renderização JavaScript 3 e a renderização em navegador completo 8. Requisições com falha custam 0. Um acerto de cache custa o mesmo que o fetch que o armazenou. Peça ao agente para definir max_cost em cada requisição, para que ele nunca gaste mais do que você espera.