Getting Started¶

Installation¶

Install from PyPI:

pip install porkbun-mcp

Or with uv:

uv add porkbun-mcp

Configuration¶

API Credentials¶

Get your API keys from the Porkbun API Access page.

Set them as environment variables:

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

MCP Client Configuration¶

Claude Desktop¶

Add to ~/.config/claude/claude_desktop_config.json:

{
  "mcpServers": {
    "porkbun": {
      "command": "porkbun-mcp",
      "env": {
        "PORKBUN_API_KEY": "pk1_...",
        "PORKBUN_SECRET_KEY": "sk1_..."
      }
    }
  }
}

Other MCP Clients¶

porkbun-mcp supports both stdio (default) and SSE transports:

# stdio (default)
porkbun-mcp

# SSE transport
porkbun-mcp --transport sse

Read-Only Mode¶

By default, porkbun-mcp runs in read-only mode for safety. Write operations (create, edit, delete) are blocked until explicitly enabled.

To enable writes:

# Via environment variable
export PORKBUN_GET_MUDDY=true
porkbun-mcp

# Via CLI flag
porkbun-mcp --get-muddy

Update your MCP client configuration to include --get-muddy in args if you need write operations.

Verify Setup¶

Test your connection with the ping tool. It will return your public IP address if credentials are valid.