Porkbun MCP

🚀 porkbun-mcp

porkbun-mcp 是一個適用於 Porkbun DNS API 的 MCP 服務器。藉助模型上下文協議，它能夠管理 DNS 記錄、域名、DNSSEC、SSL 證書等內容。

🚀 快速開始

你可以直接使用 uvx 運行該項目（無需安裝）：

uvx porkbun-mcp

SSE 傳輸

uvx porkbun-mcp --transport sse

✨ 主要特性

• 支持通過模型上下文協議管理 Porkbun 的 DNS 記錄、域名、DNSSEC、SSL 證書等。
• 具備只讀模式，保障操作安全，可按需啟用寫操作。
• 提供多種 MCP 客戶端配置方式，方便集成到不同的開發環境中。
• 擁有豐富的工具集，涵蓋 DNS、域名、DNSSEC、SSL、定價等多個方面的操作。
• 提供預定義的工作流，指導常見的 DNS 操作。

📦 安裝指南

配置 Porkbun API 憑證

將你的 Porkbun API 憑證設置為環境變量：

export PORKBUN_API_KEY="pk1_..."
export PORKBUN_SECRET_KEY="sk1_..."

你可以從 Porkbun API 訪問頁面 獲取 API 密鑰。

只讀模式（默認）

為了安全起見，porkbun-mcp 默認以只讀模式運行。在顯式啟用之前，寫操作（創建、編輯、刪除）將返回錯誤。

啟用寫操作

你可以通過以下兩種方式啟用寫操作：

環境變量方式：

export PORKBUN_GET_MUDDY=true

CLI 標誌方式：

uvx porkbun-mcp --get-muddy

💻 使用示例

MCP 客戶端配置

Claude Desktop

在 ~/.config/claude/claude_desktop_config.json 中添加以下內容：

{
  "mcpServers": {
    "porkbun": {
      "command": "uvx",
      "args": ["porkbun-mcp", "--get-muddy"],
      "env": {
        "PORKBUN_API_KEY": "pk1_...",
        "PORKBUN_SECRET_KEY": "sk1_..."
      }
    }
  }
}

⚠️ 重要提示：為了安全起見，建議在只讀模式下移除 args 中的 --get-muddy。

Claude Code / Codex

在 ~/.claude/settings.json 中添加以下內容：

{
  "mcpServers": {
    "porkbun": {
      "command": "uvx",
      "args": ["porkbun-mcp", "--get-muddy"],
      "env": {
        "PORKBUN_API_KEY": "pk1_...",
        "PORKBUN_SECRET_KEY": "sk1_..."
      }
    }
  }
}

VS Code

在你的工作區的 .vscode/mcp.json 中添加以下內容（或者使用 MCP: Add Server 命令）：

{
  "servers": {
    "porkbun": {
      "command": "uvx",
      "args": ["porkbun-mcp", "--get-muddy"],
      "env": {
        "PORKBUN_API_KEY": "pk1_...",
        "PORKBUN_SECRET_KEY": "sk1_..."
      }
    }
  }
}

OpenCode

在你的 opencode.json 配置文件中添加以下內容：

{
  "mcp": {
    "porkbun": {
      "type": "local",
      "command": ["uvx", "porkbun-mcp", "--get-muddy"],
      "environment": {
        "PORKBUN_API_KEY": "pk1_...",
        "PORKBUN_SECRET_KEY": "sk1_..."
      }
    }
  }
}

📚 詳細文檔

可用工具

DNS

• dns_list - 列出域名的所有 DNS 記錄
• dns_get - 通過 ID 獲取特定的 DNS 記錄
• dns_get_by_name_type - 通過子域名和類型獲取 DNS 記錄
• dns_create - 創建新的 DNS 記錄
• dns_edit - 通過 ID 編輯 DNS 記錄
• dns_edit_by_name_type - 通過子域名和類型編輯 DNS 記錄
• dns_delete - 通過 ID 刪除 DNS 記錄
• dns_delete_by_name_type - 通過子域名和類型刪除 DNS 記錄

域名

• domains_list - 列出賬戶中的所有域名
• domains_get_nameservers - 獲取域名的名稱服務器
• domains_update_nameservers - 更新域名的名稱服務器
• domains_get_url_forwards - 獲取 URL 轉發規則
• domains_add_url_forward - 添加 URL 轉發規則
• domains_delete_url_forward - 刪除 URL 轉發規則
• domains_check_availability - 檢查域名可用性和定價
• domains_get_glue_records - 獲取域名的膠水記錄

DNSSEC

• dnssec_list - 列出域名的 DNSSEC 記錄
• dnssec_create - 創建 DNSSEC 記錄
• dnssec_delete - 刪除 DNSSEC 記錄

SSL

• ssl_retrieve - 獲取域名的 SSL 證書捆綁包

定價

• pricing_get - 獲取所有可用 TLD 的定價

實用工具

• ping - 測試 API 連接性並獲取你的公共 IP

預定義工作流

預定義的工作流可指導常見的 DNS 操作：

• dns_setup - 為新服務器設置基本 DNS（根 A + www 記錄）
• dns_audit - 審核 DNS 配置是否存在問題（重複記錄、缺少電子郵件記錄、低 TTL 等）
• email_dns_setup - 配置電子郵件 DNS（MX、SPF、DKIM、DMARC）
• update_server_ip - 在遷移到新服務器 IP 時更新 DNS 記錄
• subdomain_setup - 為新子域名創建 A/CNAME 記錄

🔧 技術細節

開發

# 安裝依賴
uv sync --dev

# 運行所有檢查
make check

# 單獨的命令
make lint       # ruff 檢查
make format     # ruff 格式化
make typecheck  # ty 類型檢查
make test       # 帶覆蓋率的 pytest 測試

📄 許可證

本項目採用 MIT 許可證。