Reference Documentation

This section provides comprehensive reference documentation for the WhoisXML API MCP Server. Whether you need to understand available tools, configure advanced options, or set up specialized deployment modes, you'll find detailed information here.

🛠️ Tools Reference

Complete guide to all 17 available WhoisXMLAPI tools

Learn about every tool available in the MCP server, including parameters, examples, and use cases:

Domain WHOIS information and history
DNS lookups and historical data
IP geolocation and network intelligence
Email verification and domain categorization
Reverse DNS, IP, and WHOIS searches
SSL certificate analysis and threat intelligence

Complete Tools Reference →

⚙️ Server Configuration

Comprehensive configuration options and examples

Master all configuration methods including command-line flags, environment variables, and client-specific setups:

Command-line flags and parameters
Environment variable configuration
MCP client integration examples
Security considerations and best practices

Complete Configuration Reference →

🌐 HTTP Server Mode (Streamable HTTP)

Advanced HTTP-based deployment for web applications

Set up the server for web-based integrations and multiple client scenarios:

HTTP server mode configuration
Remote AI service integration
Automation platform connectivity
Multiple client support

Complete HTTP Server Mode Guide →

Documentation Categories

Core Reference

Essential documentation for understanding and using the server:

Document	Purpose	When to Use
Tools Reference	Learn about all 17 available tools	When you need to understand what tools are available and how to use them
Configuration	Configure server behavior and options	When setting up the server or customizing its behavior

Advanced Features

Specialized deployment modes and advanced configurations:

Document	Purpose	When to Use
HTTP Server Mode	Streamable HTTP server deployment	For web applications, automation tools, or multiple client scenarios

Quick Access by Use Case

🔍 "What tools are available?"

You want to explore the capabilities of the MCP server and understand what domain, DNS, and security information you can access.

→ Tools Reference - Complete catalog of all 17 tools with examples

⚙️ "How do I configure the server?"

You need to customize server behavior, set timeouts, disable specific tools, or configure authentication.

→ Server Configuration - All configuration options with examples

🌐 "How do I deploy for web applications?"

You're building a web application, automation workflow, or need multiple clients to share one server instance.

→ HTTP Server Mode - Streamable HTTP server deployment guide

🔧 "I need specific examples for my setup"

You want configuration examples for your specific deployment method (Docker, npm, binary) and AI client.

→ Configuration Examples - Client-specific configuration templates

Getting Started

If you're new to the WhoisXML API MCP Server:

Prerequisites - Set up Docker or Node.js
Installation Guide - Install the server
AI Client Configuration - Configure your AI client

Troubleshooting

If you're experiencing issues:

General Troubleshooting - Common problems and solutions
Configuration Issues - Client integration problems
HTTP Debugging - API and networking issues

Reference Quick Links

Command-Line Help

# Get help for any installation method
mcp-whoisxmlapi --help                    # Binary
npx @whoisxmlapidotcom/mcp-whoisxmlapi --help    # npm
docker run --rm whoisxmlapidotcom/mcp-whoisxmlapi:v1 --help  # Docker

Tool Discovery

# List all available tools (requires API token)
WHOISXMLAPI_TOKEN=your-token mcp-whoisxmlapi --help

Configuration Validation

# Validate JSON configuration files
python -m json.tool your-config.json
jq . your-config.json