MCP Namecheap Registrar

🚀 Namecheap Domain MCP for Cursor

A Namecheap domain API that provides Cursor MCP (Model Context Protocol) integration for the Cursor AI interface. It allows you to check domain availability, get pricing information, and register domains directly through Cursor.

YouTube Demonstration:

🚀 Quick Start

This tool is a Namecheap domain API integrated with Cursor MCP, enabling you to perform domain - related operations directly within Cursor.

✨ Features

1. Check Domain Availability

   • Check the availability of single or multiple domains.
   • Support multiple top - level domains (TLD).

2. Get Pricing Information

   • Display registration, renewal, and transfer prices.
   • Support price display for different years.

3. Register Domains

   • Register domains using default settings or custom options.
   • Support custom DNS servers.
   • Support enabling or disabling Whois privacy protection.

4. Sandbox Mode

   • Provide a test environment without actual purchases.
   • Use independent API keys and accounts.

📦 Installation

Install Dependencies

npm install namecheap-api cursor-mcp

Configuration Steps

1. Create a .env file Create a .env file in the project root directory and add the following content:

NAMECHEAP_API_KEY=your_api_key_here
NAMECHEAP_USERNAME=your_username_here
REGISTRANT_PROFILE=registrant-profile.json

2. Prepare the registrant configuration file Create a registrant-profile.json file and ensure it contains the following fields:

{
    "name": "John Doe",
    "address1": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "postalcode": "12345",
    "country": "US",
    "phonenumber": "+1.5555555555",
    "email": "email@example.com"
}

💻 Usage Examples

Check Domain Availability

node check-availability.js example.com anotherexample.net

Get Pricing Information

node get-pricing.js example.com

Register Domains

The registration process consists of two steps to ensure security:

1. Step 1 - Display Details

node register-domain.js --step=1 example.com

2. Step 2 - Confirm Purchase After completing Step 1, the system will prompt you to enter a confirmation code. Please carefully review all information and then enter confirm.

Sandbox Mode

For testing purposes, set the following in the .env file:

NODE_ENV=sandbox

This will use Namecheap's sandbox API environment without actual purchases. Please ensure you have independent sandbox API credentials.

📚 Documentation

Frequently Asked Questions

1. How to get an API key?

Log in to your Namecheap account, go to the "User Center" > "API" section, and generate a new API key.

2. What permissions are required?

Ensure your API key has the following permissions:

• Domain Services: Read/Write
• WHOISguard Services: Read/Write

3. How to handle errors?

a. Authentication failure

• Ensure your API key and username are correct.
• Check if your IP address is on Namecheap's whitelist.

b. Registrant configuration file not found

• Verify the existence of the registrant-profile.json file.
• Ensure the file contains valid JSON format and all required fields are filled.

c. Domain registration failure

• Check your Namecheap account balance.
• Confirm the domain is actually available.
• Ensure the information in the registrant configuration file is complete and correct.

⚠️ Important Note

This tool uses Namecheap's live API by default for actual domain purchases. Make sure you have carefully read the documentation and understand all possible security precautions before running the script.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please refer to CONTRIBUTING.md to learn how to contribute to this project.