Quickstart
The easiest way to use Spidra is through the hosted MCP server. There is nothing to install or keep running.The hosted MCP server uses your Spidra account and consumes credits in the same way as direct API requests. There is no separate keyless usage tier.
Connect your client
Pick your client below for exact setup steps. Every client can sign in with OAuth in one click, or use a static API key if you’d rather not.- Claude Code
- Claude Desktop
- Cursor
- VS Code
- Windsurf
- Antigravity
- Codex
- GitHub Copilot CLI
- OpenCode
Run:Start Claude Code and run
/mcp if you need to complete authentication or check the connection.If you want to use an API key instead:What you can do
The Spidra MCP server exposes tools for common scraping and crawling workflows.- Scrape pages: extract clean Markdown or structured JSON from one or more URLs.
- Process URLs in batches: run the same extraction across up to 50 URLs in parallel while keeping each result separate.
- Crawl websites: start from one URL and describe which links Spidra should follow.
- Interact before scraping: click, type, scroll, and loop over page elements before extracting content.
- Use residential proxies: access geo-restricted or bot-protected pages when your Spidra configuration allows it.
- Inspect previous jobs: retrieve scrape and crawl history without starting the work again.
- Check usage: inspect request, credit, and token usage from your MCP client.
Available tools
For complete parameters, schemas, examples, and tool-selection guidance, see the full MCP reference.
Run Spidra locally
You can also run the MCP server on your own machine using the standard input/output transport. This is useful when your client does not support remote MCP servers, when you want to manage the process locally, or when you need to point the server at a different Spidra API environment.Run with npx
No global installation is required:Install globally
/mcp to confirm that Spidra is connected.
Self-host over Streamable HTTP
The package can also run as a Streamable HTTP server. Use this when you want to host your own MCP endpoint, place it behind your own network controls, or point it at a different Spidra API environment.SPIDRA_API_KEY from the server environment and send the appropriate API key with each request instead:
Use Spidra with n8n
You can connect Spidra directly to an n8n AI Agent through the MCP Client Tool node.- Add an AI Agent node to your workflow.
- Add an MCP Client Tool to the agent.
- Set the MCP endpoint to:
- Choose the Streamable HTTP transport.
- Configure authentication with your Spidra API key as a bearer token.
- Choose whether to expose all Spidra tools or only the tools your workflow needs.
Configuration
These environment variables apply when you run the MCP server yourself.
For HTTP connections, you can also send the API key with each request:
Error handling
Spidra returns API failures as MCP tool errors rather than crashing the server. Error messages are designed to tell the client what to do next:- Rate-limit errors indicate when the request can be retried.
- Validation errors identify the input that needs to change.
- Permanent errors explain when retrying the same request will not help.
- Long-running scrape operations return a job ID that can be checked with
spidra_check_scrape_status.
Development
The MCP server is open source:Full MCP Reference
Client configuration, parameters, tool examples, troubleshooting, and detailed reference material.
SDKs Overview
Prefer working in code? Explore the official Spidra SDKs.

