New: pagination on person search, fuzzy matching, and more. See what's changed →
Whitepages Pro API

MCP Server

Connect to Whitepages Pro API via Model Context Protocol for AI assistants

The Whitepages MCP (Model Context Protocol) server allows AI assistants like Claude Desktop, Cursor, and other MCP-compatible tools to directly access Whitepages Pro API functionality.

Quick Start

Get Your API Key

If you don't have an API key yet, get a trial key.

Configure Your AI Tool

Choose your AI tool below and copy the configuration.

Configuration

Claude Desktop does not support custom headers directly for remote MCP servers. Use mcp-remote as a bridge to handle authentication.

Add this to your Claude Desktop configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "whitepages": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://api.whitepages.com/mcp",
        "--header",
        "X-Api-Key: ${WHITEPAGES_API_KEY}"
      ],
      "env": {
        "WHITEPAGES_API_KEY": "YOUR_API_KEY_HERE"
      }
    }
  }
}

Replace YOUR_API_KEY_HERE with your actual Whitepages Pro API key.

After saving, restart Claude Desktop for the changes to take effect.

Claude Code connects to remote HTTP servers with custom headers directly — no bridge needed. Add the MCP server using the CLI or edit your configuration file directly.

Using CLI:

claude mcp add --transport http whitepages https://api.whitepages.com/mcp \
  --header "X-Api-Key: YOUR_API_KEY_HERE" --scope user

Or edit ~/.claude.json (macOS/Linux) or %USERPROFILE%\.claude.json (Windows):

{
  "mcpServers": {
    "whitepages": {
      "type": "http",
      "url": "https://api.whitepages.com/mcp",
      "headers": {
        "X-Api-Key": "YOUR_API_KEY_HERE"
      }
    }
  }
}

Replace YOUR_API_KEY_HERE with your actual Whitepages Pro API key.

After running claude mcp add, reconnect with /mcp in an open session. A full restart is only needed if you edited ~/.claude.json by hand.

Add the server with a single codex mcp add command. It uses mcp-remote as a stdio bridge to send the X-Api-Key header:

codex mcp add whitepages -- npx -y mcp-remote https://api.whitepages.com/mcp \
  --header "X-Api-Key: YOUR_API_KEY_HERE"

Or edit ~/.codex/config.toml directly to connect to the remote server natively, without the mcp-remote bridge:

[mcp_servers.whitepages]
url = "https://api.whitepages.com/mcp"
http_headers = { "X-Api-Key" = "YOUR_API_KEY_HERE" }

Replace YOUR_API_KEY_HERE with your actual Whitepages API key.

In the codex TUI, run /mcp to confirm the server is connected.

Gemini CLI connects to remote Streamable HTTP servers with custom headers. Add the server with the CLI or edit your settings.json directly.

Using CLI:

gemini mcp add whitepages https://api.whitepages.com/mcp \
  --transport http --header "X-Api-Key: YOUR_API_KEY_HERE"

Or edit ~/.gemini/settings.json:

{
  "mcpServers": {
    "whitepages": {
      "httpUrl": "https://api.whitepages.com/mcp",
      "headers": {
        "X-Api-Key": "YOUR_API_KEY_HERE"
      }
    }
  }
}

Replace YOUR_API_KEY_HERE with your actual Whitepages API key.

Run /mcp inside Gemini CLI to confirm the server is connected.

Cursor supports remote HTTP servers with custom headers directly. Add this to your Cursor MCP settings file:

macOS/Linux: ~/.cursor/mcp.json

Windows: %USERPROFILE%\.cursor\mcp.json

{
  "mcpServers": {
    "whitepages": {
      "url": "https://api.whitepages.com/mcp",
      "headers": {
        "X-Api-Key": "YOUR_API_KEY_HERE"
      }
    }
  }
}

Restart Cursor after updating the configuration.

Cline supports custom headers directly for remote MCP servers.

In VS Code with Cline extension:

  1. Click the MCP Servers icon in the Cline panel
  2. Select the Configure tab
  3. Click "Edit MCP Settings" to open cline_mcp_settings.json
  4. Add this configuration:
{
  "mcpServers": {
    "whitepages": {
      "url": "https://api.whitepages.com/mcp",
      "headers": {
        "X-Api-Key": "YOUR_API_KEY_HERE"
      }
    }
  }
}

OpenCode supports custom headers directly for remote MCP servers.

Add this to your opencode.json configuration:

{
  "mcp": {
    "whitepages": {
      "type": "remote",
      "url": "https://api.whitepages.com/mcp",
      "headers": {
        "X-Api-Key": "YOUR_API_KEY_HERE"
      },
      "enabled": true
    }
  }
}

Zed currently focuses on stdio-based MCP servers. Use mcp-remote to connect to remote servers.

Add this to your Zed settings (~/.config/zed/settings.json or via Zed → Settings):

{
  "context_servers": {
    "whitepages": {
      "command": {
        "path": "npx",
        "args": [
          "mcp-remote",
          "https://api.whitepages.com/mcp",
          "--header",
          "X-Api-Key: YOUR_API_KEY_HERE"
        ]
      }
    }
  }
}

Zed's remote MCP support is still evolving. Check the Zed MCP documentation for the latest configuration format.

While Postman doesn't directly support MCP, you can test the underlying API:

  1. Create a new request
  2. Set method to POST
  3. Set URL to https://api.whitepages.com/mcp
  4. Add headers:
    • Content-Type: application/json
    • Accept: text/event-stream
    • X-Api-Key: YOUR_API_KEY_HERE
  5. Set body (raw JSON):
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "initialize",
  "params": {
    "protocolVersion": "2024-11-05",
    "capabilities": {},
    "clientInfo": {
      "name": "postman-test",
      "version": "1.0.0"
    }
  }
}

Note: Postman may have limitations with Server-Sent Events (SSE) responses. For full MCP testing, use the MCP Inspector instead.

The MCP Inspector is the official tool for testing MCP servers:

  1. Install and run:
npx @modelcontextprotocol/inspector https://api.whitepages.com/mcp
  1. In the Inspector UI:

    • Transport Type: SSE
    • URL: https://api.whitepages.com/mcp
    • Click Authentication button
    • Add header: X-Api-Key = YOUR_API_KEY_HERE
    • Click Connect
  2. Once connected, you can explore available tools and test them interactively.

Authentication

All requests to the Whitepages MCP server require authentication via the X-Api-Key header:

X-Api-Key: YOUR_API_KEY_HERE

If you don't have an API key:

What's Available

Connecting to the MCP server gives your AI assistant two things: tools that call the Whitepages Pro API, and the full corpus of documentation.

Data tools

These tools make live, metered calls to the Whitepages Pro API:

  • Person search — look up people by name, phone, or address
  • Person by ID — retrieve full detail for a specific person
  • Property search — look up properties by address
  • Property by ID — retrieve full detail for a specific property
  • Account usage — report your API usage over a date range

Each tool bills identically to the equivalent REST endpoint — see Billing.

Documentation

The complete Whitepages Pro API documentation is available directly through the MCP server, in two forms that expose the same content:

  • MCP resources — for assistants that support resources, every document is addressable as a resource that can be browsed and attached directly.
  • Documentation tools — for assistants that don't support resources, the same corpus is reachable through the list_documentation, search_documentation, and get_documentation tools.

Because both forms serve the identical corpus, no assistant is left without the documentation.

Some MCP clients don't currently support MCP resources — including the Anthropic products Claude Code, Claude Desktop, and Co-Work. This is a limitation of those harnesses' MCP support, not of the Whitepages MCP server or its resources. On these clients, the documentation tools (list_documentation, search_documentation, get_documentation) provide the same complete corpus.

The exact tool names and their parameters are shown in your AI assistant after connecting.

Usage in AI Assistants

After configuring the MCP server, you can ask your AI assistant to use Whitepages data:

Example prompts:

  • "Find contact information for John Smith in Seattle"
  • "Look up who owns the phone number 206-555-0100"
  • "Get details about the property at 123 Main St, Seattle, WA"

Your AI assistant will automatically use the appropriate Whitepages MCP tools to fulfill these requests.

Billing

MCP requests are billed identically to direct API calls. Each tool invocation through the MCP server consumes credits from your subscription plan at the same rate as if you called the REST API directly.

For example:

  • A person search via MCP = same cost as a person search via REST API
  • A reverse phone lookup via MCP = same cost as a reverse phone lookup via REST API

See Billing for detailed pricing information.

Troubleshooting

Connection Failed: Verify your API key is correct and has active credits.

Rate Limits: MCP requests count against your API rate limits. Monitor your usage in the dashboard.

If you encounter issues:

  1. Check that your API key is valid and has credits
  2. Verify the server URL is correct: https://api.whitepages.com/mcp
  3. Ensure the X-Api-Key header is properly configured
  4. Restart your AI tool after configuration changes

Related

On this page