Skip to main content

WebQuest MCP is a Model Context Protocol (MCP) server that exposes powerful web search and scraping tools to AI agents and MCP-compatible clients.

Project description

WebQuest MCP Logo

WebQuest MCP

WebQuest MCP is a Model Context Protocol (MCP) server that exposes powerful web search and scraping tools to AI agents and MCP-compatible clients.

For available scrapers and browsers, see the WebQuest documentation.

Installation

Installing using pip:

pip install webquest-mcp

Installing using uv:

uv add webquest-mcp

Usage

Starting the server

To start the WebQuest MCP server, run:

webquest-mcp

The server reads its configuration from environment variables (or a .env file loaded automatically). Available settings:

  • OPENAI_API_KEY (required): OpenAI API key for scrapers.
  • HYPERBROWSER_API_KEY (required): Hyperbrowser API key.
  • WEBQUEST_MCP_AUTH_SECRET (optional): JWT secret to enable authenticated requests. Leave unset to disable auth.
  • WEBQUEST_MCP_AUTH_AUDIENCE (optional, default webquest-mcp): JWT audience to validate when auth is enabled.
  • WEBQUEST_MCP_TRANSPORT (optional, default stdio): MCP transport. Supported values: stdio, sse, streamable-http.
  • WEBQUEST_MCP_HOST (optional, default localhost): Host to bind when the transport is HTTP-based.
  • WEBQUEST_MCP_PORT (optional, default 8000): Port to use when the transport is HTTP-based.

Example .env:

OPENAI_API_KEY=your_openai_api_key
HYPERBROWSER_API_KEY=your_hyperbrowser_api_key
WEBQUEST_MCP_AUTH_SECRET=your_jwt_secret_key
WEBQUEST_MCP_AUTH_AUDIENCE=webquest-mcp
WEBQUEST_MCP_TRANSPORT=streamable-http
WEBQUEST_MCP_HOST=localhost
WEBQUEST_MCP_PORT=8000

Token generation

To generate an authentication token for the MCP client, set the required environment variables and run the generator.

The token generator uses the same WEBQUEST_MCP_* prefix as the server.

Required settings:

  • WEBQUEST_MCP_AUTH_SECRET: JWT secret used by the server.
  • WEBQUEST_MCP_AUTH_SUBJECT: Identifier for the client receiving the token.

Optional settings:

  • WEBQUEST_MCP_AUTH_AUDIENCE (default webquest-mcp)
  • WEBQUEST_MCP_AUTH_EXPIRATION_DAYS (default 365)

Example .env:

WEBQUEST_MCP_AUTH_SECRET=your-secret-key
WEBQUEST_MCP_AUTH_SUBJECT=client-name
WEBQUEST_MCP_AUTH_AUDIENCE=webquest-mcp
WEBQUEST_MCP_AUTH_EXPIRATION_DAYS=365

Run the generator:

webquest-mcp token

Docker

Run the published image:

docker run --rm -p 8000:8000 --env-file .env \
  -e WEBQUEST_MCP_HOST=0.0.0.0 \
  mustafametesengul/webquest-mcp

Disclaimer

This tool is for educational and research purposes only. The developers of WebQuest MCP are not responsible for any misuse of this tool. Scraping websites may violate their Terms of Service. Users are solely responsible for ensuring their activities comply with all applicable laws and website policies.

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

webquest_mcp-0.14.0.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

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

webquest_mcp-0.14.0-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file webquest_mcp-0.14.0.tar.gz.

File metadata

  • Download URL: webquest_mcp-0.14.0.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.1

File hashes

Hashes for webquest_mcp-0.14.0.tar.gz
Algorithm Hash digest
SHA256 be406bea7b131595b282c8b42f9155a9df56de608af96ff3cc868da8b23d6a70
MD5 7d0f006dbf8afe6575032ae0446587a7
BLAKE2b-256 1652bf582ebce9a91ee35435ce987186f43bef16c04a074f4933b35f580e3325

See more details on using hashes here.

File details

Details for the file webquest_mcp-0.14.0-py3-none-any.whl.

File metadata

File hashes

Hashes for webquest_mcp-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fb7e54ca7829ca0522ab7b049c590100bee54f40dd30b0e6c98b5585a9cc8642
MD5 39285578d92926a7fecef11723d075d5
BLAKE2b-256 55ee7ed845a56678070136fa7501bed539ba15cc6f1366531a3dae0c9baadf68

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