Skip to main content
The hosted endpoint is:
Use a client that supports remote Streamable HTTP and custom authentication headers. This is the product data server; it is separate from any documentation-search MCP offered by Mintlify.

Codex

Configure GMSCRAPER_API_KEY in the environment where Codex starts, then add the server:
This stores the environment variable name rather than the key in the MCP configuration. Start a new session and ask the client to list G Maps Crawl tools.

Claude Code

The shell expands the variable before Claude Code writes its configuration. Keep that user configuration private; do not use project scope for a secret-bearing header.

Configure your client

Supply the API key through your client’s secret environment. The following is the common configuration shape; environment interpolation differs by client, so replace the placeholder using that client’s secret mechanism.
REST and MCP accept API-KEY or a Bearer token. MCP also accepts GMS-API-KEY and X-API-KEY. Send one credential, not conflicting headers.

Python SDK

Install the official Python MCP SDK and use the discovery example in gmapscrawl-mcp:
The example reads GMSCRAPER_API_KEY, initializes a session, and lists tools without starting work.

First tool call

Call search_google_maps with flat arguments (do not wrap them in REST’s operation and input envelope):
Use a fresh mutation identifier in real work, preserving it for retries. Continue with get_scrape_job and then get_scrape_results using the returned job ID.
Use a key from the API keys page; enter a name to create one, then copy it into your secret environment. New keys are live keys and requests use your API allowance. If you already have a test key, its results are simulated. A tool listing does not establish live access; check availability.
Example prompt: “Using my configured G Maps Crawl connection, request only page 1 for coffee shops in Seattle. Follow the job within two minutes, return up to 25 stored records, and report simulation and completeness. Do not expand the search.”