Porkbun MCP Server

🚀 Porkbun MCP Server

This repository contains a Miracle Custom Protocol (MCP) server for interacting with the Porkbun domain registrar. The server enables automated management through the Claude Desktop application or other compatible tools.

🚀 Quick Start

✨ Features

This implementation currently supports the following operations:

• Domain Management
  • Purchase domains
  • Cancel domains
  • Refresh domain status
  • Get a list of all registered domains
• DNS Record Management
  • Get current DNS settings
  • Add new DNS records (A, AAAA, CNAME, MX, TXT)
  • Update existing DNS records
  • Delete DNS records
• Privacy Protection
  • Enable/disable domain privacy protection

More features are under development, such as SSL certificate management and Whois privacy protection.

📦 Installation

Clone the repository

git clone https://github.com/miraclebakelaser/porkbun-mcp-server.git
cd porkbun-mcp-server

Install dependencies

npm install

Configure API keys

You can provide Porkbun's API Key and Secret Key in multiple ways (in descending order of priority):

1. System environment variables: Set the PORKBUN_API_KEY and PORKBUN_SECRET_API_KEY system environment variables.
2. Custom .env file: Create an .env file anywhere and specify its path via command-line arguments (see the section on running the server).
3. Default .env file: Create a file named porkbun-mcp-server/.env in the project root directory with the following content:

PORKBUN_API_KEY=YOUR_API_KEY
PORKBUN_SECRET_API_KEY=YOUR_SECRET_API_KEY

Replace YOUR_API_KEY and YOUR_SECRET_API_KEY with your actual keys. Note: If you plan to commit this project to a version control system, add the .env file to .gitignore.

Compilation

Compile TypeScript code to JavaScript:

npm run build

This will generate executable JavaScript files in the build/ directory.

Running the Server

You can directly run the compiled server using Node.js.

• Standard startup: Use the default .env file or system environment variables:

  npm start
  # Or run directly:
  node build/index.js
  

• Custom .env path startup: Specify the .env file path via the --dotenv-path or -p command-line arguments:

  node build/index.js --dotenv-path /path/to/your/.env
  # Or shorthand:
  node build/index.js -p /path/to/your/.env
  

• Development mode: Use the dev script to monitor file changes and automatically rebuild and restart:

  # Start with the default `.env`
  npm run dev
  
  # Start with a custom `.env` path
  npm run dev -- --dotenv-path /path/to/your/.env
  # Or
  npm run dev -- -p /path/to/your/.env
  

The server uses the MCP stdio transport protocol (standard input/output) for communication.

💻 Usage Examples

Using with Claude Desktop

To use this server with the Claude Desktop application, add the following under the "mcpServers" configuration:

"Porkbun":
{
  "name": "Porkbun",
  "type": "custom",
  "url": "file://path/to/porkbun-mcp-server/build/index.js"
}

Ensure the server remains running, and Claude Desktop will automatically connect.

📚 Documentation

The complete API documentation can be found in the MCP Protocol repository.

📄 License

MIT License

Copyright (c) 2023 miraclebakelaser

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

This document serves as a guide for using and configuring the Porkbun MCP Server and is translated from the official documentation.