Whodis MCP Server

🚀 Whois MCP Server

This project offers a Model Context Protocol (MCP) server specifically designed for checking domain name availability through WHOIS queries. It enables AI assistants or other tools to integrate domain availability checks into their workflows.

🚀 Quick Start

Prerequisites

• Node.js (>=18.x): Download
• Git: For version control

Step 1: Clone and Install

# Clone the repository
git clone https://github.com/vinsidious/whodis-mcp-server.git
cd whodis-mcp-server

# Install dependencies
npm install

Step 2: Run the Server

# Run in development mode
npm run dev

# Run in production mode
npm start

✨ Features

MCP Service

• Check Domain Availability: Check the registration status of a specified domain name through WHOIS queries.
• Get Registration Information: Extract and display detailed information about registered domain names, such as the registrar, expiration date, etc.

CLI Tool

• Interactive Mode: Allows users to input domain names and get real-time feedback.
• Batch Processing: Supports checking the availability of multiple domain names at once.

General Features

• Domain Availability Check: Use the whoiser library to perform WHOIS queries and determine whether a domain name appears to be available or registered.
• MCP Tool Integration: Exposes a check-domain-availability tool for MCP clients (e.g., AI assistants) to use.
• CLI Interface: Includes a command-line interface (whodis-mcp-server check-domain-availability ...) for direct use and testing.
• Structured Logging: Provides detailed logging for debugging and monitoring.
• Configurability: Supports configuration through environment variables or a .env file.

📚 Documentation

What is MCP?

The Model Context Protocol (MCP) is an open standard that allows AI systems to securely and contextually connect to external tools and data sources. This server implements the MCP standard to provide domain availability information.

🔧 Technical Details

Core Components

• WHOIS Queryer: Responsible for performing WHOIS data retrieval and parsing.
• MCP Interface Adapter: Implements API endpoints compatible with the MCP protocol.
• Logging System: Records all operations for auditing and troubleshooting.

Code Structure

whodis-mcp-server/
├── src/                 # Source code directory
│   ├── whois.js         # WHOIS query implementation
│   ├── mcp-interface.js # MCP protocol adapter
│   └── logger.js        # Logging module
├── package.json          # Dependency management file
└── .env.example           # Environment variable example file

Development Guide

Install Dependencies

npm install

Run Tests

npm test

Debug Logging

DEBUG=true npm start

Configuration

• Environment Variables:

  export MCP_SERVER_PORT=3000
  export WHOIS_API_KEY=your_api_key
  

Release Process

1. Commit changes and follow conventional commit messages (e.g., feat:, fix:, chore:).
2. Push changes to the main branch.
3. The workflow located at .github/workflows/ci-semantic-release.yml will automatically perform building, testing, versioning, and npm publishing.

📄 License

ISC License