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 VS Code com Copilot

Adicione o servidor MCP do Spicrawl ao VS Code. O Copilot no modo agente passa a ler páginas web como Markdown limpo.

Configure

Três passos dão ao Copilot as ferramentas, o conhecimento para escrever código do Spicrawl e regras para usar os dois. spicrawl init --client vscode faz os dois primeiros por você.

  1. Crie .vscode/mcp.json no projeto. O VS Code usa a chave servers, não mcpServers. O campo de senha faz o VS Code pedir sua chave uma vez e guardá-la, então o arquivo é seguro para commitar:

    .vscode/mcp.json
    {
      "inputs": [
        {
          "type": "promptString",
          "id": "spicrawl-api-key",
          "description": "Spicrawl API key",
          "password": true
        }
      ],
      "servers": {
        "spicrawl": {
          "type": "http",
          "url": "https://mcp.spicrawl.com/mcp",
          "headers": { "Authorization": "Bearer ${input:spicrawl-api-key}" }
        }
      }
    }
  2. Rode MCP: List Servers na Paleta de Comandos e inicie spicrawl. Informe sua chave quando solicitado.

  3. Instale a skill e faça commit dela:

    bash
    spicrawl skill install --client vscode
    
    # Without the CLI:
    mkdir -p .github/skills/spicrawl
    curl -fsSL https://app.spicrawl.com/skill.md -o .github/skills/spicrawl/SKILL.md
  4. Salve isto como .github/copilot-instructions.md, ou adicione ao arquivo que você já tem:

    .github/copilot-instructions.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. Abra a visualização Chat, mude para o modo Agente e abra o seletor de ferramentas. spicrawl lista 25 ferramentas spicrawl_*.

A CLI do Copilot e o agente do Copilot na nuvem leem, cada um, a própria configuração de MCP. A página da documentação cobre os dois.

Uma primeira tarefa para testar

Abra o Copilot Chat no modo Agent e pergunte:

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 agente deve chamar spicrawl_scrape com format: "markdown". Ele deve adicionar render: true só se o primeiro resultado vier vazio.

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

Por que o VS Code usa "servers" e não "mcpServers"?

Esse é o formato do próprio VS Code. Use a chave servers em .vscode/mcp.json, como no exemplo desta página.

Onde a minha chave é armazenada?

The inputs entry with password: true makes VS Code ask for the key once and store it. The file only holds ${input:spicrawl-api-key}, so you can commit it.

Funciona com a Copilot CLI e o agente na nuvem?

Sim, mas cada um lê a própria configuração de MCP. A Copilot CLI usa copilot mcp add. O agente na nuvem é configurado por um administrador do repositório em Settings → Copilot → MCP servers. A página da documentação cobre os dois.

O que o spicrawl init --client vscode grava?

Ele grava .vscode/mcp.json e a skill em .github/skills/spicrawl/SKILL.md. Não grava o arquivo de instruções nem a configuração da Copilot CLI ou do agente na nuvem.

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.