WhoisXML API MCP Server
WhoisXML API
Docker Container
WhoisXML API
Docker Container
  • Introduction
  • Installation Guide
    • Docker Installation
    • npx Installation
    • Binary Installation
  • AI Client Configuration
    • Claude Desktop
    • Claude Code
    • Cursor
    • Gemini
  • Prerequisites
    • Docker Installation & Usage
    • Node.js Usage Guide
  • Reference
    • Server Configuration Reference
    • Tools Reference
    • HTTP Server Mode
  • Troubleshooting
    • Docker Troubleshooting
    • npx Troubleshooting
    • Binary Troubleshooting
    • AI Client Troubleshooting
    • HTTP Debugging & Troubleshooting
  • Downloads

AI Client Configuration

This section provides comprehensive configuration guides for popular AI clients that support the Model Context Protocol (MCP). Each client has its own setup requirements and configuration methods.

Already Installed?

If you haven't installed the MCP server yet, start with our Installation Guide to choose your preferred method (Docker, npm, or binary).

Supported AI Clients

We provide detailed setup guides for these AI clients:

🖥️ Desktop Applications

Claude Desktop

Anthropic's desktop AI assistant with native MCP support

Complete Claude Desktop Setup Guide →

  • Best for: Desktop users who prefer a GUI interface
  • Installation method: Docker (recommended) or binary
  • Node.js required: No (bundles its own runtime)
  • Configuration: JSON file-based
  • Key features: One-time setup, automatic startup

Cursor

AI-powered code editor built on VS Code

Complete Cursor Setup Guide →

  • Best for: Developers and code editing workflows
  • Installation method: Docker, npm, or binary
  • Node.js required: No (for basic usage)
  • Configuration: GUI and file-based options
  • Key features: Native MCP support, one-click setup, IDE integration

💻 Command Line Interfaces

Claude Code

Anthropic's command-line AI assistant

Complete Claude Code Setup Guide →

  • Best for: Terminal users and CLI workflows
  • Installation method: npm (recommended) or Docker
  • Node.js required: Yes (22+ LTS)
  • Configuration: CLI commands
  • Key features: Terminal integration, scripting support

Gemini CLI Tools

Google Gemini API command-line tools

Complete Gemini Setup Guide →

  • Best for: Google AI service users and custom integrations
  • Installation method: npm (recommended) or Docker
  • Node.js required: Yes (22+ LTS)
  • Configuration: Custom bridge scripts
  • Key features: Google AI integration, custom MCP bridge

Quick Setup Overview

Prerequisites for All Clients

  1. MCP Server Installed - Choose from:

    • Docker - Most reliable, works everywhere
    • npm - Fastest for Node.js users
    • Binary - Minimal dependencies
  2. WhoisXMLAPI Token - Get yours from whoisxmlapi.com

  3. Platform Dependencies (if required):

    • Docker Installation & Usage - For Docker-based setups
    • Node.js Installation - For CLI tools only

Configuration Pattern

All AI clients follow a similar configuration pattern:

{
  "mcpServers": {
    "whoisxmlapi": {
      "command": "method-specific-command",
      "args": ["method-specific-arguments"],
      "env": {
        "WHOISXMLAPI_TOKEN": "your-api-token-here"
      }
    }
  }
}

Configuration varies by:

  • Installation method (Docker, npm, binary)
  • Client type (desktop app vs CLI)
  • Platform (Windows, macOS, Linux)

Client Comparison

ClientTypeBest ForNode.js RequiredSetup Complexity
Claude DesktopDesktop AppGeneral usersNoEasy
CursorCode EditorDevelopersNoEasy
Claude CodeCLITerminal usersYesMedium
Gemini CLICLIGoogle AI usersYesAdvanced

Common Configuration Examples

Since the configuration is often quite similar across all clients, you can use these as examples for your own configuration.

Docker-based Setup (Recommended)

{
  "mcpServers": {
    "whoisxmlapi": {
      "command": "docker",
      "args": [
        "run", "--rm", "-i",
        "--env", "WHOISXMLAPI_TOKEN",
        "whoisxmlapidotcom/mcp-whoisxmlapi:v1"
      ],
      "env": {
        "WHOISXMLAPI_TOKEN": "your-token-here"
      }
    }
  }
}

npm-based Setup (CLI Tools)

{
  "mcpServers": {
    "whoisxmlapi": {
      "command": "npx",
      "args": ["-y", "@whoisxmlapidotcom/mcp-whoisxmlapi"],
      "env": {
        "WHOISXMLAPI_TOKEN": "your-token-here"
      }
    }
  }
}

Binary-based Setup

{
  "mcpServers": {
    "whoisxmlapi": {
      "command": "/path/to/mcp-whoisxmlapi",
      "env": {
        "WHOISXMLAPI_TOKEN": "your-token-here"
      }
    }
  }
}

Environment Variables

All clients support these common environment variables:

  • WHOISXMLAPI_TOKEN ✅ Required

    • Description: Your API token
    • Example: "at-...abc123"
  • WHOISXMLAPI_HTTP_DEBUG (Optional)

    • Description: Debug log file path
    • Example: "/tmp/debug.log"
  • WHOISXMLAPI_DISABLED_TOOLS (Optional)

    • Description: Tools to disable
    • Example: "threat_intelligence"

Security Best Practices

  • Never commit API tokens to version control
  • Use environment variables for token storage
  • Consider using different tokens for different environments
  • Rotate tokens regularly

Other Editors and IDEs

VS Code Extensions

Many VS Code AI extensions support MCP servers using the standard configuration format:

  • GitHub Copilot - Check extension documentation for MCP support
  • Cline - Supports MCP server integration
  • Continue - MCP-compatible development assistant
  • RooCode - AI coding assistant with MCP support

VS Code MCP Configuration

Most VS Code AI extensions use the same JSON configuration format shown above. Consult the specific extension's documentation for exact configuration details.

Other MCP-Compatible Clients

For any MCP-compatible client, use the example configurations listed above.

Verification Steps

After configuring any client:

  1. Restart the client completely, unless it supports toggling MCP servers on and off.
  2. Start a new conversation so the tools are refreshed.
  3. Test with a simple query: "Look up WHOIS information for example.com"
  4. Verify tool access: You should see MCP tools being called.
  5. Check for errors: Look for any configuration or authentication issues.

Troubleshooting

Common Issues Across All Clients

Check our troubleshooting guide for common issues.

Client-Specific Support

Each client guide includes dedicated troubleshooting sections:

  • Claude Desktop Troubleshooting
  • Cursor Troubleshooting
  • Claude Code Troubleshooting
  • Gemini CLI Troubleshooting

Additional Help

For installation and general issues:

  • Installation Troubleshooting - General server issues
  • Docker Troubleshooting - Docker-specific problems
  • npm Troubleshooting - Node.js and npm issues
  • Binary Troubleshooting - Binary installation problems
  • HTTP Debugging - API and networking issues

Advanced Configuration

Server Configuration Options

For advanced server configuration options:

  • Server Configuration Reference - All flags, parameters, and environment variables
  • Tools Reference - Complete tool documentation
  • HTTP Server Mode - Streamable HTTP transport for web applications

Next Steps

  1. Choose your AI client from the guides above
  2. Follow the specific setup guide for detailed instructions
  3. Explore the tools available in the Tools Reference
  4. Configure advanced features using the Server Configuration guide
  5. Set up monitoring with HTTP Debugging if needed

Ready to configure your AI client? Pick your client from the guides above and get started! 🚀

Last Updated: 9/20/25, 3:39 AM
Prev
Installation Guide
Next
Prerequisites