Skip to main content

Porkbun DNS MCP Server

Code style: crackerjack Runtime: oneiric Framework: FastMCP uv Python: 3.13+

MCP server for managing Porkbun DNS records through a FastMCP interface.

Version: 0.2.0 Status: Internal Bodai integration component

Quick Links

Quality & CI

Crackerjack is the standard quality-control and CI/CD gate for Porkbun DNS MCP changes. Local verification should mirror the Crackerjack workflow used across the Bodai ecosystem.


Overview

Porkbun DNS MCP exposes DNS record management workflows through a FastMCP server. It is focused on record lookup, creation, update, and deletion for domains managed through Porkbun while keeping provider credentials and request validation in a narrow integration boundary.

This server is intentionally separate from porkbun-domain-mcp. DNS owns record-level operations; domain owns registration, renewal, transfer, and pricing workflows.

Capabilities

Implemented tool surface (the first 5 bullets are MCP tools registered via @app.tool(); the last two are HTTP endpoints / internal helpers, not MCP tools — see the Tool Reference and Health Checks sections for the exact surface):

  • Record listing: list all DNS records for a domain
  • Record lookup: retrieve a specific DNS record by ID
  • Record creation: create A, AAAA, CNAME, MX, TXT, NS, SRV, CAA, or ALIAS records
  • Record editing: update selected fields on an existing DNS record
  • Record deletion: remove a DNS record by ID
  • Credential health metadata: PorkbunDNSSettings.has_credentials() reports whether API credentials are configured (internal helper, not an MCP tool)
  • HTTP health routes: /health and /healthz for MCP client and process supervision checks (Starlette routes, not MCP tools)

Quick Start

Prerequisites

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

Local Setup

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

Run With Credentials

export PORKBUN_DNS_API_KEY="your-api-key"
export PORKBUN_DNS_SECRET_KEY="your-secret-key"
uv run porkbun-dns-mcp start
uv run porkbun-dns-mcp health

The default HTTP bind is 127.0.0.1:3042.

CLI Commands

The CLI is built with mcp-common and provides the standard lifecycle command surface used by Bodai MCP servers.

uv run porkbun-dns-mcp start      # Start the HTTP MCP server
uv run porkbun-dns-mcp stop       # Stop the managed server process
uv run porkbun-dns-mcp restart    # Restart the managed server process
uv run porkbun-dns-mcp status     # Show process status
uv run porkbun-dns-mcp health     # Run the local health probe

MCP Server Configuration

Claude / Codex Style Configuration

Add the server to an MCP client configuration:

{
  "mcpServers": {
    "porkbun-dns": {
      "command": "uv",
      "args": ["run", "porkbun-dns-mcp", "start"],
      "cwd": "/Users/les/Projects/porkbun-dns-mcp",
      "env": {
        "PORKBUN_DNS_API_KEY": "your-api-key",
        "PORKBUN_DNS_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:3042/health
curl http://127.0.0.1:3042/healthz

Tool Reference

Tool Purpose Required Inputs
list_dns_records List all DNS records for a domain domain
get_dns_record Retrieve one DNS record by ID domain, record_id
create_dns_record Create a DNS record domain, record_type, name, content
edit_dns_record Update selected fields on a DNS record domain, record_id
delete_dns_record Delete a DNS record domain, record_id

Supported record types are A, AAAA, CNAME, MX, TXT, NS, SRV, CAA, and ALIAS.

Tool responses follow a consistent ToolResponse shape:

{
  "success": true,
  "message": "Found 4 DNS records for example.com",
  "data": {},
  "error": null,
  "next_steps": []
}

Configuration

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

Setting Environment Variable Default
API key PORKBUN_DNS_API_KEY empty
Secret key PORKBUN_DNS_SECRET_KEY empty
Base URL PORKBUN_DNS_BASE_URL https://porkbun.com/api/json/v3
Timeout PORKBUN_DNS_TIMEOUT 30.0
Max retries PORKBUN_DNS_MAX_RETRIES 3
HTTP host PORKBUN_DNS_HTTP_HOST 127.0.0.1
HTTP port PORKBUN_DNS_HTTP_PORT 3042
Log level PORKBUN_DNS_LOG_LEVEL INFO
JSON logs PORKBUN_DNS_LOG_JSON true
Enable HTTP transport PORKBUN_DNS_ENABLE_HTTP_TRANSPORT false

Project Structure

porkbun_dns_mcp/
  cli.py              # mcp-common lifecycle CLI
  client.py           # Porkbun DNS API client boundary
  config.py           # Pydantic settings and logging
  models.py           # Typed DNS record models
  server.py           # FastMCP application factory
  tools/dns_tools.py  # Registered MCP tools
settings/
  porkbun-dns.yaml    # Committed defaults
tests/
  test_schema_validation.py

Development

uv sync --group dev
uv run pytest
uv run ruff check porkbun_dns_mcp tests
uv run ruff format porkbun_dns_mcp tests
uv run pyright porkbun_dns_mcp

Use targeted tests when isolating schema behavior:

uv run pytest tests/test_schema_validation.py -v

Security Notes

  • Do not commit Porkbun API keys, secret keys, real customer domains, or sensitive record values.
  • Treat DNS mutations as production-impacting operations.
  • Review generated delete_dns_record and edit_dns_record calls before exposing them to unattended agent workflows.
  • Scrub real domain details from fixtures, screenshots, and troubleshooting logs.

Download files

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

Source Distribution

porkbun_dns_mcp-0.2.1.tar.gz (254.8 kB view details)

Uploaded Source

Built Distribution

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

porkbun_dns_mcp-0.2.1-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file porkbun_dns_mcp-0.2.1.tar.gz.

File metadata

  • Download URL: porkbun_dns_mcp-0.2.1.tar.gz
  • Upload date:
  • Size: 254.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for porkbun_dns_mcp-0.2.1.tar.gz
Algorithm Hash digest
SHA256 fd530f7bfb4140d1fc5afec43d383850d8c50f9d8546de22efdb0dc585c823cf
MD5 27ccb7aeac9f175928d241c82fd5b286
BLAKE2b-256 44d006903f984a7495cc5268e70c7f5eea392aef17549bc71a434311f62bb074

See more details on using hashes here.

File details

Details for the file porkbun_dns_mcp-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: porkbun_dns_mcp-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for porkbun_dns_mcp-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 540421bb8f9bef685200d619ef59c871f23dd28cb50fc0d250958d83a2b5ab8b
MD5 d14cbd0593ff8c3464d8208a54b9e4d8
BLAKE2b-256 7bab55362654252ad1e11e2ff9bc096ed63601dff70879edd689f1e5fdfa15ab

See more details on using hashes here.

Release history Release notifications | RSS feed

0.3.0

2 files

This release

0.2.1 This release

2 files

0.2.0

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

Supported by

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