Spicrawl 现已支持 OpenAI Agents SDK、LangChain、Codex、Claude Code 等。查看集成
跳到内容

在 VS Code 中用 Copilot 抓取网页

将 Spicrawl MCP 服务器添加到 VS Code。之后 agent 模式下的 Copilot 就可以将网页读取为干净的 Markdown。

设置它

三步就能让 Copilot 拥有工具、编写 Spicrawl 代码的知识,以及使用两者的规则。spicrawl init --client vscode 会替你完成前两步。

  1. 在项目中创建 .vscode/mcp.json。VS Code 使用 servers 键,而不是 mcpServers。密码输入框会让 VS Code 向你询问一次 key 并保存,因此该文件可以放心提交:

    .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. 从命令面板运行 MCP: List Servers,并启动 spicrawl。出现提示时输入你的 key。

  3. 安装该技能并提交:

    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. 将其保存为 .github/copilot-instructions.md,或添加到你已有的文件中:

    .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. 打开 Chat 视图,切换到 智能体 模式,并打开工具选择器。spicrawl 会列出 25 个 spicrawl_* 工具。

Copilot CLI 和 Copilot 云端智能体各自读取自己的 MCP 配置。文档页面 同时涵盖两者。

可以先试的第一个任务

在 Agent 模式下打开 Copilot Chat 并提问:

提示词
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.

智能体应使用 format: "markdown" 调用 spicrawl_scrape。仅当第一个结果为空时,才应加上 render: true。

它能做什么

该服务器为智能体提供 25 个 spicrawl_* 工具。每次调用都在你的 API key 下运行,限制和积分与直接调用 API 相同。

  • 读取一个页面: spicrawl_scrape 返回 Markdown(默认)、文本、HTML、JSON 或 PDF。
  • 读取多个页面: spicrawl_batch_submit 最多可排入 10,000 个 URL。之后用 spicrawl_batch_status 和 spicrawl_batch_results 跟进。
  • 登录后的页面: spicrawl_session_create 会在多次调用之间保留 cookie 和存储。
  • 调试失败: spicrawl_requests_list 和 spicrawl_request_get。
  • 查看用量: spicrawl_usage_summary 及其他用量工具。这些工具需要具有 read 权限范围的 key。
  • 查资料: spicrawl_docs_search 和 spicrawl_docs_read 用于搜索和阅读 Spicrawl 文档。

有一个工具 spicrawl_browser_connect_url 已列出但即将推出。在 spicrawl_scrape 上,渲染参数是 render,而不是 API 的 js_render。

须知

  • 不支持爬取。 Spicrawl 不会跟随链接或查找页面。请把 URL 交给智能体。
  • 每次请求的积分。 普通抓取 1 积分。JavaScript 渲染 3。完整浏览器渲染 8。
  • 失败免费。 失败的请求费用为 0 积分。
  • 缓存节省的是时间,而不是积分。 缓存命中的费用与存储它的那次获取相同。
  • 为每次调用设置上限。 设置 max_cost 后,可能超出预算的请求会在运行前被拒绝。
  • 即将推出: 托管代理、隐身模式、远程浏览器,以及基于自然语言提示词的 AI 提取。目前你可以自带代理。

常见问题

VS Code 为什么使用“servers”而不是“mcpServers”?

这是 VS Code 自己的格式。请使用 .vscode/mcp.json 中的 servers 键,如本页示例所示。

我的 key 存储在哪里?

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.

它能与 Copilot CLI 和云端智能体一起使用吗?

可以,但各自读取自己的 MCP 配置。Copilot CLI 使用 copilot mcp add。云端智能体由仓库管理员在 Settings → Copilot → MCP servers 下设置。文档页面涵盖了两者。

spicrawl init --client vscode 会写入什么?

它会写入 .vscode/mcp.json 和位于 .github/skills/spicrawl/SKILL.md 的技能。它不会写入指令文件,也不会写入 Copilot CLI 或云端智能体的配置。

每个页面要多少钱?

普通抓取 1 积分,JavaScript 渲染 3,完整浏览器渲染 8。失败的请求为 0。缓存命中的费用与存入该缓存的那次抓取相同。让智能体在每次请求上设置 max_cost,这样花费就不会超出你的预期。