Skip to content

setup.md

Latest commit

 

History

History
52 lines (39 loc) · 1.88 KB

setup.md

File metadata and controls

52 lines (39 loc) · 1.88 KB

MCP Server Setup

Server Variants

ScraperAPI offers two MCP server variants. Detect which is active by checking available tools.

Remote (Hosted) — recommended

All 22 tools: scrape, google_search, google_news, google_jobs, google_shopping, google_maps_search, amazon_product, amazon_search, amazon_offers, walmart_search, walmart_product, walmart_category, walmart_reviews, ebay_search, ebay_product, redfin_for_sale, redfin_for_rent, redfin_search, redfin_agent, crawler_job_start, crawler_job_status, crawler_job_delete.

{
  "mcpServers": {
    "ScraperAPI": {
      "command": "npx",
      "args": ["mcp-remote", "https://mcp.scraperapi.com/mcp", "--header", "Authorization: Bearer ${SCRAPERAPI_API_KEY}"]
    }
  }
}

Local (Self-Hosted)

Python-based, installed via PyPI (pip install scraperapi-mcp-server). Only the scrape tool is available. Requires Python 3.11+.

{
  "mcpServers": {
    "ScraperAPI": {
      "command": "python",
      "args": ["-m", "scraperapi_mcp_server"],
      "env": {
        "API_KEY": "<YOUR_SCRAPERAPI_API_KEY>"
      }
    }
  }
}

Variant Detection

  • If google_search or crawler_job_start are available → remote. Use all 22 tools.
  • If only scrape is available → local. Use scrape for everything. For structured Google data, use scrape with autoparse: true and outputFormat: "json" on Google URLs.

Environment Variables

Variant Env Var Description
Remote SCRAPERAPI_API_KEY API key passed as Bearer token to the hosted MCP server
Local API_KEY API key passed to the local Python MCP server

Both variables hold the same ScraperAPI key value — the different names reflect what each server variant expects. Direct users to https://www.scraperapi.com/dashboard to obtain or manage their key.