Prerequisites

Before installing and using the WhoisXML API MCP Server, you'll need to set up the appropriate runtime environment. Choose the setup that matches your preferred installation method.

Installation Methods Overview

The WhoisXML API MCP Server offers three installation approaches, each with different prerequisites:

🐳 Docker Installation

Best for: Desktop applications like Claude Desktop and Cursor Prerequisites: Docker Desktop or Docker Engine Benefits: Isolated environment, no local dependencies, easy updates

📦 Node.js Installation

Best for: CLI tools like Claude Code and Gemini Prerequisites: Node.js 22+ LTS and npm Benefits: Direct execution, fast startup, integrated with Node.js ecosystem

💾 Binary Installation

Best for: Standalone deployment or specific environments Prerequisites: None (self-contained executable) Benefits: No runtime dependencies, single file deployment

Docker Installation & Usage

Docker provides the most reliable and consistent way to run the WhoisXML API MCP Server across all platforms.

Why Choose Docker?

  • No local dependencies - Everything runs in an isolated container
  • Automatic updates - Pull the latest version anytime
  • Security isolation - Server runs in a sandboxed environment
  • Cross-platform consistency - Works identically on all operating systems

What You'll Learn

  • Installing Docker Desktop on Windows, macOS, and Linux
  • Pulling and running the WhoisXML API MCP Server Docker image
  • Configuring AI clients to use Docker containers
  • Advanced Docker configuration and troubleshooting

Complete Docker Installation Guide →

Node.js Usage Guide

Node.js is required for CLI-based AI tools and provides the fastest way to run the MCP server directly.

Why Choose Node.js?

  • Fast startup - Direct execution without container overhead
  • CLI integration - Perfect for command-line AI tools
  • npm ecosystem - Easy package management and updates
  • Development friendly - Ideal for testing and development

What You'll Learn

  • Installing Node.js 22+ LTS on all major platforms
  • Setting up npm and global packages
  • Using npx for zero-installation execution
  • Node.js security best practices

Complete Node.js Installation Guide →

Quick Start Decision Tree

Not sure which method to choose? Use this decision tree:

🤔 What AI client are you using?

├── 🖥️  Desktop Applications (Claude Desktop, Cursor)
│   └── ✅ Choose Docker Installation
│       └── 📖 Follow the Docker Guide →
│
├── 💻 CLI Tools (Claude Code, Gemini CLI)
│   └── ✅ Choose Node.js Installation
│       └── 📖 Follow the Node.js Guide →
│
└── 🔧 Custom/Advanced Setup
    ├── ✅ Binary Installation (no prerequisites)
    └── ✅ Or choose Docker/Node.js based on your needs

Next Steps

Once you've completed the prerequisite setup:

  1. Installation Guide - Install the WhoisXML API MCP Server
  2. AI Client Configuration - Configure your specific AI client
  3. Tools Reference - Explore all 17 available tools
  4. Troubleshooting - Get help when needed

Getting Help

If you encounter issues during prerequisite setup:

Last Updated: