Skip to main content

Unofficial MCP server for Porkbun domain management

Project description

Porkbun Domain MCP Server

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

MCP server for Porkbun domain-management workflows.

Version: 0.1.3 Status: Internal Bodai integration component

Quick Links

Quality & CI

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


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 is intentionally separate from porkbun-dns-mcp. Domain owns registration and lifecycle workflows; DNS owns record-level changes.

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 the standard lifecycle command surface used by Bodai MCP servers.

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

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 Purpose Required Inputs
list_domains List domains in the Porkbun account none
get_domain_info Retrieve domain metadata domain
get_auth_code Retrieve transfer authorization code domain
renew_domain Renew a domain registration domain
get_pricing Retrieve TLD pricing none

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.

Setting Environment Variable Default
API key PORKBUN_DOMAIN_API_KEY empty
Secret key PORKBUN_DOMAIN_SECRET_KEY empty
Base URL PORKBUN_DOMAIN_BASE_URL https://porkbun.com/api/json/v3
Timeout PORKBUN_DOMAIN_TIMEOUT 30.0
Max retries PORKBUN_DOMAIN_MAX_RETRIES 3
HTTP host PORKBUN_DOMAIN_HTTP_HOST 127.0.0.1
HTTP port PORKBUN_DOMAIN_HTTP_PORT 3043
Log level PORKBUN_DOMAIN_LOG_LEVEL INFO
JSON logs PORKBUN_DOMAIN_LOG_JSON true

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

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.

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_domain_mcp-0.1.4.tar.gz (244.2 kB view details)

Uploaded Source

Built Distribution

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

porkbun_domain_mcp-0.1.4-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file porkbun_domain_mcp-0.1.4.tar.gz.

File metadata

  • Download URL: porkbun_domain_mcp-0.1.4.tar.gz
  • Upload date:
  • Size: 244.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","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_domain_mcp-0.1.4.tar.gz
Algorithm Hash digest
SHA256 9c827d9cc8d4fd1d1a13e41168bc735f6b910f234a967ddb4071116885f52fcb
MD5 baafd86270d0aa0268e5cb116e77dd26
BLAKE2b-256 1bee57160613f7546b214d9a655d007089c186a7a0338c55c15cfe4f5be32ad0

See more details on using hashes here.

File details

Details for the file porkbun_domain_mcp-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: porkbun_domain_mcp-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","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_domain_mcp-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 01b7643f418a163da070aae1425c7c3e629fa457169bb437d92a35cab1b0060c
MD5 1a4dec397084742627db0197a3eaf7b8
BLAKE2b-256 786295d611777b182a4c7c79b9919df9994122f5ad0b165622c50f325b9db409

See more details on using hashes here.

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