Skip to main content

LangChain tools for the MrScraper web-scraping API

Project description

langchain-mrscraper

LangChain integration package for the MrScraper SDK.

This package exposes MrScraper capabilities as LangChain tools so agents can:

  • Fetch rendered HTML from protected websites
  • Create AI scrapers from natural-language prompts
  • Rerun AI/manual scrapers (single and bulk)
  • List and fetch scraping results

Installation

pip install -U langchain-mrscraper

or:

uv add langchain-mrscraper

mrscraper-sdk is installed automatically as a dependency, so users do not need to install it separately.

Quick start

import os
from langchain_mrscraper import MrScraperToolkit

os.environ["MRSCRAPER_API_KEY"] = "your-token"

tools = MrScraperToolkit().get_tools()

Use with an agent

from langgraph.prebuilt import create_react_agent
from langchain_openai import ChatOpenAI
from langchain_mrscraper import MrScraperToolkit

tools = MrScraperToolkit(token="your-token").get_tools()
agent = create_react_agent(ChatOpenAI(model="gpt-4o-mini"), tools)

Available tools

  • mrscraper_fetch_html
  • mrscraper_create_scraper
  • mrscraper_rerun_ai_scraper
  • mrscraper_bulk_rerun_ai_scraper
  • mrscraper_rerun_manual_scraper
  • mrscraper_bulk_rerun_manual_scraper
  • mrscraper_get_all_results
  • mrscraper_get_result_by_id

API styles

You can initialize via:

  • MrScraperToolkit(...).get_tools() (recommended)
  • load_mrscraper_tools(...) convenience function
  • per-tool constructors with token="..." or mrscraper_api_key="..."
  • environment variables MRSCRAPER_API_KEY (preferred) or MRSCRAPER_API_TOKEN

Tools vs. loaders

This integration is intentionally tools-first. MrScraper endpoints are action-oriented (fetch, create, rerun, list, retrieve) and best represented as BaseTool methods that agents can call explicitly.

A document loader abstraction is usually better when the primary job is deterministic "URL -> documents" ingestion into vector stores. MrScraper can support that in a separate package later, but this package should remain focused on agent tools.

Testing

pytest tests/unit_tests -v

Integration smoke tests (real API):

MRSCRAPER_API_KEY=your-token pytest tests/integration_tests -m integration -v

Local release workflow

  1. Update version in pyproject.toml
  2. Build: python -m build
  3. Upload to TestPyPI: twine upload --repository testpypi dist/*
  4. Verify install from TestPyPI
  5. Upload to PyPI: twine upload dist/*

Docs files for LangChain PR

  • Provider page: docs/providers/mrscraper.mdx
  • Tool pages: docs/tools/*.mdx (one page per tool)

These are prepared to submit to langchain-ai/docs.

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

langchain_mrscraper-0.1.1.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

langchain_mrscraper-0.1.1-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file langchain_mrscraper-0.1.1.tar.gz.

File metadata

  • Download URL: langchain_mrscraper-0.1.1.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for langchain_mrscraper-0.1.1.tar.gz
Algorithm Hash digest
SHA256 619c068f7ad87d8501671932b7bcff1d6f4ab11d09643d73779d8ac403954069
MD5 bc37e3f05a3568c5906ea5f745e777b9
BLAKE2b-256 c5d80eda8033060ab39f6e08338ec66a1f0bcf4c8110a17982c69f54cb08c348

See more details on using hashes here.

File details

Details for the file langchain_mrscraper-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for langchain_mrscraper-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f1be2e6a2e21b714b9bbd918cabbc2c59f64d8826644f78cad5a5c6e967f4bdb
MD5 617bed1280f3392208348677df133327
BLAKE2b-256 4189b4569f6edaf7aa84b82e860624f027e8b6d8c8e0e99aa2f8117e5cfe7054

See more details on using hashes here.

Supported by

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