Skip to main content

Oxylabs MCP server

Project description

Oxylabs + MCP

Oxylabs MCP Server

Access web data seamlessly with Oxylabs via the Model Context Protocol

📖 Overview

The Oxylabs MCP server provides a bridge between AI models and the web. It enables them to scrape any URL, render JavaScript-heavy pages, extract and format content for AI use, bypass anti-scraping measures, and access geo-restricted web data from 195+ countries.

This implementation leverages the Model Context Protocol (MCP) to create a secure, standardized way for AI assistants to interact with web content.

✨ Key Features

Scrape content from any site
  • Extract data from any URL, including complex single-page applications
  • Fully render dynamic websites using headless browser support
  • Choose full JavaScript rendering, HTML-only, or none
  • Emulate Mobile and Desktop viewports for realistic rendering
Automatically get AI-ready data
  • Automatically clean and convert HTML to Markdown for improved readability
  • Use automated parsers for popular targets like Google, Amazon, and etc.
Bypass blocks & geo-restrictions
  • Bypass sophisticated bot protection systems with high success rate
  • Reliably scrape even the most complex websites
  • Get automatically rotating IPs from a proxy pool covering 195+ countries
Flexible setup & cross-platform support
  • Set rendering and parsing options if needed
  • Feed data directly into AI models or analytics tools
  • Works on macOS, Windows, and Linux
Built-in error handling and request management
  • Comprehensive error handling and reporting
  • Smart rate limiting and request management

💡 Example Queries

When you've set up the MCP server with Claude, you can make requests like:

  • Could you scrape https://www.google.com/search?q=ai page?
  • Scrape https://www.amazon.de/-/en/Smartphone-Contract-Function-Manufacturer-Exclusive/dp/B0CNKD651V with parse enabled
  • Scrape https://www.amazon.de/-/en/gp/bestsellers/beauty/ref=zg_bs_nav_beauty_0 with parse and render enabled
  • Use web unblocker with render to scrape https://www.bestbuy.com/site/top-deals/all-electronics-on-sale/pcmcat1674241939957.c

✅ Prerequisites

Before you begin, make sure you have:

  • Oxylabs Account: Obtain your username and password from Oxylabs (1-week free trial available)

Basic Usage

Via Smithery CLI:

  • Node.js (v16+)
  • npx command-line tool

Via uv:

  • uv package manager – install it using this guide

Local/Dev Setup

  • Python 3.12+
  • uv package manager – install it using this guide

🧩 API Parameters

The Oxylabs MCP server supports these parameters:

Parameter Description Values
url The URL to scrape Any valid URL
parse Enable structured data extraction True or False
render Use headless browser rendering html or None

⚙️ Basic Setup Instructions

Install via Smithery

Automatically install Oxylabs MCP server via Smithery:

npx -y @smithery/cli install @oxylabs/oxylabs-mcp --client <client>

List of clients supported by Oxylabs at the moment:

  • claude
  • cursor

Manual MCP configuration options

  1. Config with uvx. Will install the CLI client and Oxylabs MCP server that performs calls directly to the Oxylabs API. Recommended and the most stable option at the moment.

    {
      "mcpServers": {
        "oxylabs_scraper_uvx": {
          "command": "uvx",
          "args": [
            "oxylabs-mcp"
          ],
          "env": {
            "OXYLABS_USERNAME": "OXYLABS_USERNAME",
            "OXYLABS_PASSWORD": "OXYLABS_PASSWORD"
          }
        }
      }
    }
    
  2. Config with npx. Will install the Smithery CLI client that performs calls to the Oxylabs MCP server hosted in Smithery.

    {
      "mcpServers": {
        "oxylabs-mcp": {
          "command": "npx",
          "args": [
            "-y",
            "@smithery/cli@latest",
            "run",
            "@oxylabs/oxylabs-mcp",
            "--config",
            "\"{\\\"oxylabsUsername\\\":\\\"OXYLABS_USERNAME\\\",\\\"oxylabsPassword\\\":\\\"OXYLABS_PASSWORD\\\"}\""
          ]
        }
      }
    }
    
  3. Config with uv. Will install CLI client and Oxylabs MCP server that references the local code. For the local development.

    {
      "mcpServers": {
        "oxylabs_scraper": {
          "command": "uv",
          "args": [
            "--directory",
            "/<Absolute-path-to-folder>/oxylabs-mcp",
            "run",
            "oxylabs-mcp"
          ],
          "env": {
            "OXYLABS_USERNAME": "OXYLABS_USERNAME",
            "OXYLABS_PASSWORD": "OXYLABS_PASSWORD"
          }
        }
      }
    }
    

[!NOTE] If you don't have uvx utility you need to install it first with brew install uv

[!TIP] If you run into errors with uvx, try using the full path to uvx in the command field. For example, /Users/my-user/.local/bin/uvx. If you are using Windows and experiencing issues with Cursor, refer to the guidelines described here.

Manual Setup with Claude Desktop

Navigate to Claude → Settings → Developer → Edit Config and add one of the configurations above to the claude_desktop_config.json file.

Manual Setup with Cursor AI

Navigate to Cursor → Settings → Cursor Settings → MCP. Click Add new global MCP server and add one of the configurations above.


💻 Local/Dev Setup Instructions

Clone repository

git clone <git:url>

Install dependencies

Install MCP server dependencies:

cd mcp-server-oxylabs

# Create virtual environment and activate it
uv venv

source .venv/bin/activate # MacOS/Linux
# OR
.venv/Scripts/activate # Windows

# Install dependencies
uv sync

🐞 Debugging

make run

Then access MCP Inspector at http://localhost:5173. You may need to add your username and password as environment variables in the inspector under OXYLABS_USERNAME and OXYLABS_PASSWORD.

🛠️ Technical Details

This server provides two main tools:

  1. oxylabs_scraper: Uses Oxylabs Web Scraper API for general website scraping
  2. oxylabs_web_unblocker: Uses Oxylabs Web Unblocker for hard-to-access websites

Web Scraper API supports JavaScript rendering, parsed structured data, and cleaned HTML in Markdown format. Web Unblocker offers JavaScript rendering and cleaned HTML, but doesn’t return parsed data.


License

This project is licensed under the MIT License.

About Oxylabs

Established in 2015, Oxylabs is a market-leading web intelligence collection platform, driven by the highest business, ethics, and compliance standards, enabling companies worldwide to unlock data-driven insights.

image

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oxylabs_mcp-0.1.7.tar.gz (42.9 kB view details)

Uploaded Source

Built Distribution

oxylabs_mcp-0.1.7-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file oxylabs_mcp-0.1.7.tar.gz.

File metadata

  • Download URL: oxylabs_mcp-0.1.7.tar.gz
  • Upload date:
  • Size: 42.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for oxylabs_mcp-0.1.7.tar.gz
Algorithm Hash digest
SHA256 45fcb7c622660b32849ed55259a6f120025e37785974e33ceb2eb1fc911d69b7
MD5 d69f0ca8e157ef100d638b286e934fb8
BLAKE2b-256 ffe29bb72425349b1d132e574c62e1593cb12872b059046142260623c597c3b3

See more details on using hashes here.

File details

Details for the file oxylabs_mcp-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: oxylabs_mcp-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for oxylabs_mcp-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4224479be93ab63de836ed1ad5b34131289e0f2a399fcd5d5b36f3660953adfb
MD5 85fa72614a6548aa568d4a27632431dc
BLAKE2b-256 594555be001142fcfe39c86d6a025213657d3415777df5d8ff71fc101257a037

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page