The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Webclaw listing page.
English | 简体中文
Turn websites into clean markdown, JSON, and LLM-ready context.
CLI, MCP server, REST API, and SDKs for AI agents and RAG pipelines.
Most web scraping tools give your agent one of two bad outputs:
webclaw.io is the hosted web extraction API for webclaw. This repo contains the open-source CLI, MCP server, extraction engine, and self-hostable server.
webclaw turns a URL into clean content your tools can actually use.
Use it from the terminal, wire it into Claude/Cursor through MCP, call the hosted API from your app, or self-host the OSS server.
The fastest way to connect webclaw to Claude Code, Claude Desktop, Cursor, Windsurf, OpenCode, Codex CLI, and other MCP-compatible tools:
The installer detects supported clients and configures the MCP server for you.
Download macOS, Linux, and Windows binaries from GitHub Releases.
If building from source fails because native build tools are missing, install the platform prerequisites:
| OS | Command |
|---|---|
| Debian / Ubuntu | sudo apt install -y pkg-config libssl-dev cmake clang git build-essential |
| Fedora / RHEL | sudo dnf install -y pkg-config openssl-devel cmake clang git make gcc |
| Arch | sudo pacman -S pkg-config openssl cmake clang git base-devel |
| macOS | xcode-select --install |
webclaw ships with an MCP server for AI agents.
Zero-install — point any MCP client at the npx launcher:
Or run npx create-webclaw to auto-detect your AI tools and write their configs for you.
Then ask your agent things like:
Add webclaw to Claude Code, Cursor, Windsurf, and other MCP agents in one command:
Your agent gets scrape, crawl, map, extract, summarize, diff, brand, and search
as native tools. Most sites extract locally with no API key. Set WEBCLAW_API_KEY
to handle bot-protected and JavaScript-rendered pages.
Find it on skills.sh.
| Tool | What it does | Local |
|---|---|---|
scrape | Extract one URL as markdown, text, JSON, LLM format, or HTML | Yes |
crawl | Follow same-origin links and extract discovered pages | Yes |
map | Discover URLs without extracting every page | Yes |
batch | Scrape multiple URLs in parallel | Yes |
extract | Convert page content into structured data | Yes, with local or configured LLM |
summarize | Summarize a page | Yes, with local or configured LLM |
diff | Compare page content snapshots | Yes |
brand | Extract colors, fonts, logos, and metadata | Yes |
search | Search the web and scrape results | Hosted API |
research | Multi-source research workflow | Hosted API |
| Format | Use it when you need |
|---|---|
markdown | Clean page content with structure preserved |
llm | Compact context for agents and RAG pipelines |
text | Plain text with minimal formatting |
json | Structured metadata, links, images, and extracted fields |
html | Cleaned HTML for custom processing |
The CLI and MCP server work locally without an account for the core extraction path.
Use the hosted API at webclaw.io when you need:
| Use case | Example |
|---|---|
| AI agent web access | Give Claude, Cursor, or another MCP client clean page context |
| RAG ingestion | Crawl docs, help centers, blogs, and knowledge bases |
| Competitor monitoring | Track pricing pages, changelogs, docs, and product pages |
| Structured extraction | Turn messy pages into typed JSON for automations |
| Research workflows | Search, scrape, summarize, and cite multiple sources |
| Brand intelligence | Extract logos, colors, fonts, and social metadata |
webclaw-core is pure extraction logic: no network I/O, small surface area, and usable independently from the fetching layer.
| Variable | Description |
|---|---|
WEBCLAW_API_KEY | Hosted API key |
OLLAMA_HOST | Ollama URL for local LLM features |
OPENAI_API_KEY | OpenAI-compatible LLM provider key |
OPENAI_BASE_URL | OpenAI-compatible base URL |
ANTHROPIC_API_KEY | Anthropic-compatible LLM provider key |
ANTHROPIC_BASE_URL | Anthropic-compatible base URL |
ORCAROUTER_API_KEY | OrcaRouter LLM provider key |
ORCAROUTER_BASE_URL | OrcaRouter base URL (defaults to https://api.orcarouter.ai/v1) |
WEBCLAW_PROXY | Single proxy URL |
WEBCLAW_PROXY_FILE | Proxy pool file |
The most useful contributions right now are practical and small:
Good first places to start:
If a page extracts badly, include:
Please remove secrets, cookies, private tokens, and customer data from logs before posting.
|
| SerpApi, the Web Search API. Give real-time data to your AI agents and enhance their responses with SerpApi’s structured search engine results. SerpApi supports webclaw as a Strategic Partner. |
|
ColdProxy supports webclaw as an Infrastructure Partner, providing residential IPv4,
residential IPv6, and datacenter IPv6 proxy infrastructure across 195+ countries for public data
collection, regional testing, monitoring, and web scraping workflows. Explore
ColdProxy's latest plans and available offers directly on the website.
Use code webclaw8Off for 8% off your first payment.
See the proxy-backed crawling guide
for a hands-on walkthrough of wiring ColdProxy into webclaw.
|
|
NodeMaven: The most efficient proxy provider for Web Scraping and Automation with the Highest Quality IP on the market.
Special codes for Webclaw users:
|
|
MangoProxy provides residential, ISP, datacenter, and mobile proxies across 200+ locations, backed by a 90M+ IP pool with HTTP and SOCKS5 support and high stability for web scraping and data collection at scale.
Use code 0XMASSI for 8% off ISP (Static) proxies at
mangoproxy.com.
|
Third-party plugins that integrate webclaw with AI agent platforms:
| Plugin | Platform | What it does |
|---|---|---|
| openclaw-webclaw | OpenClaw | Native webclaw v1 API plugin with 9 tools: scrape, search, crawl, extract, summarize, diff, map, batch, brand |
| hermes-webclaw | Hermes Agent | Web search provider and 9 dedicated tools for the full v1 API surface. Install with hermes plugins install jal-co/hermes-webclaw |
Built a webclaw integration? Open a PR to add it here.
Thanks to everyone improving webclaw through issues, examples, docs, bug reports, and pull requests.