Porkbun 域名管理 MCP 服务

Porkbun Domain MCP Server

MCP server for Porkbun domain-management workflows.

Version: 0.2.1 Status: Standalone FastMCP server

Quick Links

• Overview
• Capabilities
• Quick Start
• MCP Server Configuration
• Tool Reference
• Configuration
• Development

Quality & CI

Crackerjack is the standard quality-control and CI/CD gate for Porkbun Domain MCP changes. Local verification should mirror the Crackerjack workflow.

Installation via Claude Code marketplace

This repository ships as a Claude Code plugin. To install it through the marketplace, register the www-mcp-servers marketplace with Claude Code, then install porkbun-domain from it. The plugin manifest is .claude-plugin/plugin.json and the colocated .mcp.json points at the local HTTP server on port 3043. Once installed, the slash commands (/porkbun-domain-list, /porkbun-domain-pricing, /porkbun-domain-register) wrap the highest-frequency workflows and are available alongside the raw mcp__porkbun-domain__* tools. The server key is porkbun-domain (short form) — the directory keeps the long-form porkbun-domain-mcp name, but the manifest name, server key, and command namespace all share the short form.

Overview

Porkbun Domain MCP exposes domain-registration workflows through a FastMCP server. It is focused on account domain inventory, domain metadata, transfer authorization, renewal, and pricing operations while keeping provider credentials and request validation in a narrow integration boundary.

This server focuses on registration and lifecycle workflows (inventory, metadata, transfer authorization, renewal, pricing). Record-level DNS changes are out of scope.

Capabilities

Implemented tool surface:

• Domain inventory: list all domains in the configured Porkbun account
• Domain details: inspect status, TLD, registration date, expiration date, privacy, and auto-renew flags
• Transfer authorization: retrieve EPP authorization codes
• Renewal workflow: renew a domain for a selected number of years
• Pricing lookup: retrieve registration, renewal, and transfer pricing by TLD
• Credential health metadata: report whether API credentials are configured
• HTTP health routes: /health and /healthz for MCP client and process supervision checks

Quick Start

Prerequisites

• Python 3.13+
• UV package manager
• Porkbun API key and secret key

Local Setup

git clone https://github.com/lesleslie/porkbun-domain-mcp.git
cd porkbun-domain-mcp
uv sync --group dev

Run With Credentials

export PORKBUN_DOMAIN_API_KEY="your-api-key"
export PORKBUN_DOMAIN_SECRET_KEY="your-secret-key"
uv run porkbun-domain-mcp start
uv run porkbun-domain-mcp health

The default HTTP bind is 127.0.0.1:3043.

CLI Commands

The CLI is built with mcp-common and provides a standard lifecycle command surface.

uv run porkbun-domain-mcp start      # Start the HTTP MCP server
uv run porkbun-domain-mcp stop       # Stop the managed server process (requires pid_file wiring)
uv run porkbun-domain-mcp restart    # Restart the managed server process (requires pid_file wiring)
uv run porkbun-domain-mcp status     # Show process status (requires pid_file wiring)
uv run porkbun-domain-mcp health     # Run the local health probe

Note (0.2.0): stop, restart, and status rely on mcp-common's MCPServerCLIFactory lifecycle, which requires pid_file and log_file to be configured on the lifecycle settings class. The current porkbun_domain_mcp.cli.PorkbunDomainSettings does not define either field, so these commands may report "not configured" at runtime. start and health work without the lifecycle wiring.

MCP Server Configuration

Claude / Codex Style Configuration

Add the server to an MCP client configuration:

{
  "mcpServers": {
    "porkbun-domain": {
      "command": "uv",
      "args": ["run", "porkbun-domain-mcp", "start"],
      "cwd": "/Users/les/Projects/porkbun-domain-mcp",
      "env": {
        "PORKBUN_DOMAIN_API_KEY": "your-api-key",
        "PORKBUN_DOMAIN_SECRET_KEY": "your-secret-key"
      }
    }
  }
}

Use your secret manager for live credentials rather than committing them to client config.

Health Checks

curl http://127.0.0.1:3043/health
curl http://127.0.0.1:3043/healthz

Tool Reference

Tool responses follow a consistent ToolResponse shape:

{
  "success": true,
  "message": "Found 12 domains in your account",
  "data": {},
  "error": null,
  "next_steps": []
}

Configuration

Committed defaults live in settings/porkbun-domain.yaml. Runtime overrides should come from environment variables or a local .env file that is not committed.

Notes (0.2.0):

• The porkbun_domain_mcp.config.PorkbunDomainSettings model is configured with env_prefix="PORKBUN_DOMAIN_" and uses field names such as log_json, log_level, http_host, timeout, and max_retries. With pydantic-settings defaults, all 9 single-word env vars above bind via the standard UPPER_SNAKE_CASE derivation (e.g. api_key → PORKBUN_DOMAIN_API_KEY). Multi-word fields like log_json, log_level, and http_host use the literal PORKBUN_DOMAIN_LOG_JSON, PORKBUN_DOMAIN_LOG_LEVEL, and PORKBUN_DOMAIN_HTTP_HOST names listed in the table.
• PORKBUN_DOMAIN_HTTP_HOST is now read by porkbun_domain_mcp.cli.start_server_handler and passed to uvicorn.run(host=...). Override the bind address via PORKBUN_DOMAIN_HTTP_HOST or settings/local.yaml (gitignored).

Project Structure

porkbun_domain_mcp/
  cli.py                 # mcp-common lifecycle CLI
  client.py              # Porkbun domain API client boundary
  config.py              # Pydantic settings and logging
  models.py              # Typed domain and pricing models
  server.py              # FastMCP application factory
  tools/domain_tools.py  # Registered MCP tools
settings/
  porkbun-domain.yaml    # Committed defaults
tests/

Development

uv sync --group dev
uv run pytest
uv run ruff check porkbun_domain_mcp tests
uv run ruff format porkbun_domain_mcp tests

Use targeted tests when isolating domain workflows:

uv run pytest tests -k domain -v

Note (0.2.1): tests/ contains 32 tests in tests/unit/test_tool_profile.py plus a tests/test_version_sync.py guard for the package User-Agent / version stamp. The 0.2.0 release dropped --cov-fail-under while the test suite was being filled in; restore a coverage floor once the suite stabilizes.

Security Notes

• Do not commit Porkbun API keys, secret keys, billing-sensitive information, transfer authorization codes, or real account exports.
• Treat get_auth_code and renew_domain as privileged tools.
• Review generated transfer and renewal calls before exposing them to unattended agent workflows.
• Scrub real domain details from fixtures, screenshots, and troubleshooting logs.

Built on Oneiric for runtime configuration and mcp-common for the FastMCP baseline. Crackerjack gates every commit.