Skip to main content

MCP server for Porkbun DNS API

Project description

porkbun-mcp

MCP server for the Porkbun DNS API.

Manage DNS records, domains, DNSSEC, SSL certificates, and more via the Model Context Protocol.

CI codecov PyPI version Python 3.13+ License: MIT

Configuration

Set your Porkbun API credentials as environment variables:

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

Get your API keys from the Porkbun API Access page.

Read-Only Mode (Default)

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

Enabling Write Operations

To let the pig get muddy and make changes:

Environment variable:

export PORKBUN_GET_MUDDY=true

CLI flag:

uvx porkbun-mcp --get-muddy

Usage

Run directly with uvx (no installation required):

uvx porkbun-mcp

SSE transport

uvx porkbun-mcp --transport sse

MCP Client Configuration

Claude Desktop

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

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

Note: Remove --get-muddy from args for read-only mode (recommended for safety).

Claude Code / Codex

Add to ~/.claude/settings.json:

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

VS Code

Add to .vscode/mcp.json in your workspace (or use MCP: Add Server command):

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

OpenCode

Add to your opencode.json configuration:

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

Available Tools

DNS

  • dns_list - List all DNS records for a domain
  • dns_get - Get a specific DNS record by ID
  • dns_get_by_name_type - Get DNS records by subdomain and type
  • dns_create - Create a new DNS record
  • dns_edit - Edit a DNS record by ID
  • dns_edit_by_name_type - Edit DNS records by subdomain and type
  • dns_delete - Delete a DNS record by ID
  • dns_delete_by_name_type - Delete DNS records by subdomain and type

Domains

  • domains_list - List all domains in your account
  • domains_get_nameservers - Get nameservers for a domain
  • domains_update_nameservers - Update nameservers for a domain
  • domains_get_url_forwards - Get URL forwarding rules
  • domains_add_url_forward - Add a URL forwarding rule
  • domains_delete_url_forward - Delete a URL forwarding rule
  • domains_check_availability - Check domain availability and pricing
  • domains_get_glue_records - Get glue records for a domain

DNSSEC

  • dnssec_list - List DNSSEC records for a domain
  • dnssec_create - Create a DNSSEC record
  • dnssec_delete - Delete a DNSSEC record

SSL

  • ssl_retrieve - Retrieve the SSL certificate bundle for a domain

Pricing

  • pricing_get - Get pricing for all available TLDs

Utility

  • ping - Test API connectivity and get your public IP

Prompts

Pre-defined workflows to guide common DNS operations:

  • dns_setup - Set up basic DNS for a new server (root A + www records)
  • dns_audit - Audit DNS configuration for issues (duplicates, missing email records, low TTLs)
  • email_dns_setup - Configure email DNS (MX, SPF, DKIM, DMARC)
  • update_server_ip - Update DNS records when migrating to a new server IP
  • subdomain_setup - Create A/CNAME records for a new subdomain

Development

# Install dependencies
uv sync --dev

# Run all checks
make check

# Individual commands
make lint       # ruff check
make format     # ruff format
make typecheck  # ty check
make test       # pytest with coverage

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

porkbun_mcp-1.1.2.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

porkbun_mcp-1.1.2-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file porkbun_mcp-1.1.2.tar.gz.

File metadata

  • Download URL: porkbun_mcp-1.1.2.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for porkbun_mcp-1.1.2.tar.gz
Algorithm Hash digest
SHA256 5a1260c0c56146a186e705d38f4d47433e8419b5298fbc133fd9374762b36987
MD5 884d0e63f9f06cd7ad3fde2ad84463a7
BLAKE2b-256 cd168b459d81519178089ea909c656631856c831cbd017092522214dfa207a43

See more details on using hashes here.

Provenance

The following attestation bundles were made for porkbun_mcp-1.1.2.tar.gz:

Publisher: release.yml on major/porkbun-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file porkbun_mcp-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: porkbun_mcp-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 18.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for porkbun_mcp-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b34c9ba9d18a3abe594982ea8a776d461c01ed1eeae5ff51479b0ee989c04980
MD5 7bae7aa1b7f17db36016305b35ef4812
BLAKE2b-256 3c750f69e9c4980a821f3b2f1616e1dae344150aecdc4347a36c1099ea5ace6f

See more details on using hashes here.

Provenance

The following attestation bundles were made for porkbun_mcp-1.1.2-py3-none-any.whl:

Publisher: release.yml on major/porkbun-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page