Spicrawl działa teraz z OpenAI Agents SDK, LangChain, Codex, Claude Code i nie tylko.Zobacz integracje
Przejdź do treści

Web scraping w Codex

Dodaj serwer MCP Spicrawl do Codex. Będzie mógł wtedy czytać strony jako czysty Markdown.

Skonfiguruj

Trzy kroki dają Codex narzędzia, wiedzę do pisania kodu Spicrawl i reguły ich używania. Albo zrób wszystkie trzy za pomocą spicrawl init --client codex.

  1. Ustaw swój klucz API:

    bash
    export SPICRAWL_API_KEY=spicrawl_live_...   # add to your shell profile
  2. Dodaj serwer MCP. Codex odczytuje klucz z SPICRAWL_API_KEY przy każdym połączeniu, więc klucz nigdy nie trafia do pliku:

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

    To zapisuje to samo, co ta konfiguracja:

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

    Dla jednego projektu umieść tabelę w .codex/config.toml. Codex czyta ją tylko w zaufanych projektach.

  3. Zainstaluj skill:

    bash
    mkdir -p .agents/skills/spicrawl
    curl -fsSL https://app.spicrawl.com/skill.md -o .agents/skills/spicrawl/SKILL.md
  4. Wklej tę sekcję do AGENTS.md w katalogu głównym projektu:

    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. Sprawdź to za pomocą codex mcp list lub /mcp w sesji. Powinieneś zobaczyć 25 narzędzi spicrawl_*.

Albo użyj CLI

Codex działa w powłoce, więc CLI spicrawl działa bez żadnej konfiguracji. Po przekierowaniu wypisuje JSON i kończy działanie ze stałym kodem:

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

W chmurze Codex nie licz na serwer MCP. Użyj CLI lub zwykłego HTTP. Ustaw SPICRAWL_API_KEY jako zmienną środowiskową, a nie sekret, i zezwól na api.spicrawl.com w dostępie agenta do internetu.

Pierwsze zadanie na próbę

Uruchom codex w projekcie i zapytaj:

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.

Co potrafi

Serwer daje agentowi 25 narzędzi spicrawl_*. Każde wywołanie działa na Twoim kluczu API, z tymi samymi limitami i kredytami co bezpośrednie wywołanie API.

  • Przeczytaj jedną stronę: spicrawl_scrape zwraca Markdown (domyślnie), tekst, HTML, JSON lub PDF.
  • Czytaj wiele stron: spicrawl_batch_submit kolejkuje do 10,000 adresów URL. Potem użyj spicrawl_batch_status i spicrawl_batch_results.
  • Strony za logowaniem: spicrawl_session_create zachowuje ciasteczka i storage między wywołaniami.
  • Zdiagnozuj błąd: spicrawl_requests_list i spicrawl_request_get.
  • Sprawdź użycie: spicrawl_usage_summary i pozostałe narzędzia użycia. Wymagają klucza z uprawnieniem read.
  • Wyszukuj informacje: spicrawl_docs_search i spicrawl_docs_read przeszukują i czytają dokumentację Spicrawl.

Jedno narzędzie, spicrawl_browser_connect_url, jest na liście, ale wkrótce. W spicrawl_scrape argument renderowania to render, a nie js_render z API.

Warto wiedzieć

  • Bez crawlowania. Spicrawl nie podąża za linkami ani nie wyszukuje stron. Daj agentowi adresy URL.
  • Kredyty na żądanie. Zwykłe pobranie to 1 kredyt. Renderowanie JavaScriptu to 3. Renderowanie w pełnej przeglądarce to 8.
  • Błędy są darmowe. Nieudane żądanie kosztuje 0 kredytów.
  • Cache oszczędza czas, a nie kredyty. Trafienie w cache kosztuje tyle samo co pobranie, które je zapisało.
  • Ogranicz każde wywołanie. Ustaw max_cost, a żądanie, które mogłoby kosztować więcej, zostanie odrzucone, zanim się wykona.
  • Wkrótce: zarządzane proxy, tryb stealth, zdalna przeglądarka i ekstrakcja AI z promptu w zwykłym języku. Dziś możesz użyć własnego proxy.

Najczęściej zadawane pytania

Gdzie Codex przechowuje serwer?

W ~/.codex/config.toml. Aby użyć go tylko w jednym projekcie, umieść tę samą tabelę w .codex/config.toml. Codex czyta konfigurację projektu tylko w zaufanych projektach.

Czy Codex może używać CLI zamiast MCP?

Tak. Codex działa w powłoce, więc może uruchomić spicrawl scrape URL --format markdown --max-cost 3. CLI wypisuje JSON przy przekazaniu potokiem i kończy się stabilnym kodem wyjścia.

Czy działa w chmurze Codex?

Nie licz tam na serwer MCP. Użyj CLI lub zwykłego HTTP. Ustaw SPICRAWL_API_KEY jako zmienną środowiskową (nie sekret) i zezwól na api.spicrawl.com w dostępie agenta do internetu.

Dlaczego serwer zwraca 401?

SPICRAWL_API_KEY nie był ustawiony w powłoce, która uruchomiła codex. Wyeksportuj go i uruchom nową sesję.

Ile kosztuje każda strona?

Zwykłe pobranie kosztuje 1 kredyt, renderowanie JavaScriptu 3, a renderowanie w pełnej przeglądarce 8. Nieudane żądania kosztują 0. Trafienie w cache kosztuje tyle samo, co pobranie, które je zapisało. Poproś agenta, aby ustawiał max_cost w każdym żądaniu, tak by nigdy nie wydał więcej, niż się spodziewasz.