Whois MCP

🚀 WHOIS MCP Service

A WHOIS query service implemented based on the Model Context Protocol (MCP). It is a Java application that provides users with the function of querying domain name WHOIS information through a standardized interface. This server communicates via standard input and output and is compatible with MCP clients.

🚀 Quick Start

WHOIS MCP is a Java application that provides WHOIS query functionality through the Model Context Protocol. Users can query the WHOIS information of domain names through this service using a standardized interface. The server supports standard input and output communication and is compatible with MCP clients.

🎥 Demos

• Demo 1
• Demo 2
• Demo 3

✨ Features

1. Domain Validation and Cleaning: Ensure the validity of the queried domain names and handle invalid or incorrect inputs.
2. WHOIS Query: Use the Apache Commons Net library to query domain name registration information.
3. Logging: Use SLF4J to record operation logs for easy debugging and maintenance.
4. Modular Design: Each component is independent, facilitating expansion and maintenance.
5. Test Coverage: Provide comprehensive unit tests to ensure code quality.

📦 Installation

Prerequisites

• Java Development Kit (JDK) 8 or higher
• Apache Maven 3.6 or higher

Build Steps

1. Download the project source code:

   git clone https://github.com/your-repository.git
   cd whois-mcp
   

2. Build with Maven:

   mvn clean install
   

3. Run the server:

   java -jar target/whois-mcp.jar
   

🐞 Debugging Guide

Debugging with the MCP Inspector Tool

1. Download and install the MCP Inspector.
2. Open the tool and connect to the running WHOIS MCP service.
3. Use the tool interface to send query requests and view the response results.

💻 Usage Examples

For Claude Users

Add the following configuration to your settings.json file:

{
  "whoisMcp": {
    "serverUrl": "http://localhost:8080",
    "apiKey": "your_api_key"
  }
}

For VSCode Users

Run the following command in the terminal to start the service:

cd whois-mcp
mvn spring-boot:run

📚 Documentation

Project Structure

• Main Class: com.whoismcp.WhoIsMcpApplication - The main entry point of the application.
• Controllers: Handle HTTP requests and return WHOIS query results.
• Services: Contain the actual business logic, such as domain name validation and WHOIS query.
• Utils: Provide auxiliary functions, such as logging and configuration management.

Main Components

1. WhoIsMcpApplication: Responsible for the startup and configuration of the application.
2. DomainValidator: Ensure the validity of the input domain names.
3. WhoIsClient: Use the Apache Commons Net library to perform WHOIS queries.
4. Logger: Record operation logs for easy debugging.

Workflow

1. The user sends a domain name query request to the server.
2. The server receives the request and calls DomainValidator for validation.
3. After passing the validation, use WhoIsClient to initiate a WHOIS query.
4. Process the returned results and format them into a response to be returned to the user.

Whois Server Mapping

The project relies on IANA's Root Zone Database to obtain information about top - level domains.

Dependencies

• Model Context Protocol (MCP): Used to implement the MCP protocol.
• SLF4J: A logging library for easy debugging and maintenance.
• Apache Commons Net: Provides WHOIS client functionality.
• Apache Commons Validator: Used for domain name validation.
• JUnit Jupiter: A unit testing framework.

Testing Method

Run the following command to execute unit tests:

mvn test

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.

👨‍💻 Author Information

Jordi Ayala - asjordi.dev

For contact information, please visit their personal website.