Porkbun MCP Server

🚀 豬肉 bun MCP 服務器

這個項目提供了一個用於與 Porkbun 域名註冊商交互的 Miracle Custom Protocol (MCP) 服務器。藉助該服務器，你可以通過 Claude Desktop 應用或其他兼容工具實現對 Porkbun 域名的自動化管理。

🚀 快速開始

本倉庫包含的 MCP 服務器可與 Porkbun 域名註冊商進行交互，支持通過 Claude Desktop 等工具自動化管理域名。

✨ 主要特性

• 域名管理：支持購買、註銷域名，刷新域名狀態，獲取所有註冊域名列表。
• DNS 記錄管理：可獲取當前 DNS 設置，添加、更新、刪除 DNS 記錄（支持 A、AAAA、CNAME、MX、TXT 類型）。
• 隱私保護：能夠啟用或禁用域名隱私保護功能。
• 功能拓展：後續還將開發 SSL 證書管理、Whois 隱私保護等功能。

📦 安裝指南

克隆倉庫

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

安裝依賴項

npm install

配置 API 密鑰

你可以通過以下多種方式提供 Porkbun 的 API Key 和 Secret Key（按優先級從高到低）：

1. 系統環境變量：設置 PORKBUN_API_KEY 和 PORKBUN_SECRET_API_KEY 系統環境變量。
2. 自定義 .env 文件：創建一個任意位置的 .env 文件，並通過命令行參數指定其路徑（參見運行服務器部分）。
3. 默認 .env 文件：在項目根目錄下創建名為 porkbun-mcp-server/.env 的文件，內容如下：

PORKBUN_API_KEY=YOUR_API_KEY
PORKBUN_SECRET_API_KEY=YOUR_SECRET_API_KEY

請將 YOUR_API_KEY 和 YOUR_SECRET_API_KEY 替換為你的實際密鑰。注意：如果計劃將此項目提交到版本控制系統，請將 .env 文件添加到 .gitignore 中。

編譯

將 TypeScript 代碼編譯為 JavaScript：

npm run build

這將在 build/ 目錄下生成可執行的 JavaScript 文件。

運行服務器

• 標準啟動方式：使用默認 .env 文件或系統環境變量：

npm start
# 或直接運行：
node build/index.js

• 自定義 .env 路徑啟動：通過 --dotenv-path 或 -p 命令行參數指定 .env 文件路徑：

node build/index.js --dotenv-path /path/to/your/.env
# 或簡寫為：
node build/index.js -p /path/to/your/.env

• 開發模式：使用 dev 腳本監視文件變化並自動重建和重啟：

# 默認 `.env` 啟動
npm run dev

# 自定義 `.env` 路徑啟動
npm run dev -- --dotenv-path /path/to/your/.env
# 或
npm run dev -- -p /path/to/your/.env

服務器使用 MCP stdio 傳輸協議（標準輸入輸出）進行通信。

💻 使用示例

在 Claude Desktop 中使用

要將此服務器與 Claude Desktop 應用一起使用，請在 "mcpServers" 配置下添加以下內容：

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

確保服務器保持運行狀態，Claude Desktop 將自動連接。

📚 詳細文檔

完整的 API 文檔可以在 MCP 協議 倉庫中找到。

📄 許可證

MIT License

版權 (c) 2023年 miraclebakelaser

特此許可任何個人和組織使用、複製、修改、合併、發佈、分發、 sublicense，以及製造和銷售 derivative works 的權利，但需遵守以下條件：

1. 在分發或發表的衍生作品中保留上述版權聲明、本許可聲明以及下文中的免責聲明。
2. 不對保修承擔任何責任。

由於軟件有可能存在缺陷，導致任何形式的損害或其他問題（包括但不限於直接、間接、附帶或後果性損害），作者或版權持有人概不負責。