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-generator

Docker

Run the published image:

docker run --rm -p 8000:8000 mustafametesengul/webquest-mcp

Configure the server using environment variables (or a .env file) as described above.

Or use Docker Compose (builds locally by default):

docker compose up

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.10.2.tar.gz (3.7 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.10.2-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for webquest_mcp-0.10.2.tar.gz
Algorithm Hash digest
SHA256 1b5c9598a13c753edf9c1a3cb5d2117111eb2215f879712be65f4a9b767b78ec
MD5 5113adaeb1a49d93d1fb263ddd2a89fb
BLAKE2b-256 125d02ba8d74dc759b9ecabef46ef3d014298906c4e44b10c5de3c416d270d2c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for webquest_mcp-0.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5636ef7e20308559fd2b1c07599b61c030804812327af53dfd1bdd6406be3377
MD5 e7fb82950565ef02bb305955220561a3
BLAKE2b-256 ecb91756c7d42a736650ac629498baf503fcd02f35628538b9bfb14734d0bb39

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