Cursor

\n\nAdd an MCP server in Cursor settings and paste the snippet above as a server config.\nIf your setup expects an outer object, wrap it into:\n\n```json\n{\n \"mcpServers\": {\n \"porkbun-mcp\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"porkbun-mcp\"],\n \"env\": {\n \"PORKBUN_API_KEY\": \"your_porkbun_api_key\",\n \"PORKBUN_SECRET_KEY\": \"your_porkbun_secret_api_key\"\n }\n }\n }\n}\n```\n\n

\n\n

Claude Desktop (macOS)

\n\nUpdate `~/Library/Application Support/Claude/claude_desktop_config.json`:\n\n```json\n{\n \"mcpServers\": {\n \"porkbun-mcp\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"porkbun-mcp\"],\n \"env\": {\n \"PORKBUN_API_KEY\": \"your_porkbun_api_key\",\n \"PORKBUN_SECRET_KEY\": \"your_porkbun_secret_api_key\"\n }\n }\n }\n}\n```\n\n

\n\n

Other MCP clients (Windsurf, Cline, etc.)

\n\nMost clients use the same `mcpServers` shape:\n\n```json\n{\n \"mcpServers\": {\n \"porkbun-mcp\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"porkbun-mcp\"],\n \"env\": {\n \"PORKBUN_API_KEY\": \"your_porkbun_api_key\",\n \"PORKBUN_SECRET_KEY\": \"your_porkbun_secret_api_key\"\n }\n }\n }\n}\n```\n\n

\n\n### Write mode with `npx`\n\n```json\n{\n \"mcpServers\": {\n \"porkbun-mcp\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"porkbun-mcp\", \"--get-muddy\"],\n \"env\": {\n \"PORKBUN_API_KEY\": \"your_porkbun_api_key\",\n \"PORKBUN_SECRET_KEY\": \"your_porkbun_secret_api_key\"\n }\n }\n }\n}\n```\n\n### Domain create enabled (dangerous)\n\n```json\n{\n \"mcpServers\": {\n \"porkbun-mcp\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"porkbun-mcp\", \"--get-muddy\", \"--enable-domain-create\"],\n \"env\": {\n \"PORKBUN_API_KEY\": \"your_porkbun_api_key\",\n \"PORKBUN_SECRET_KEY\": \"your_porkbun_secret_api_key\"\n }\n }\n }\n}\n```\n\nImportant (Porkbun API domain registration prerequisites):\n\n- Your Porkbun account must have registered at least one domain in the past (for new accounts, the first purchase may need to be done via the web UI).\n- Your email address and phone number must be verified.\n- You must have enough account credit (API registrations are billed from account credit).\n- `cost` must be provided in pennies and must match the value returned by the domain check (minimum duration \\* price).\n- You must explicitly accept terms (`agree_to_terms=true` in this server, which maps to `agreeToTerms=\"yes\"` for Porkbun).\n\nReference:\n\n- Porkbun API v3 docs (see \"Domain Create\" and \"Domain Check\"): https://porkbun.com/api/json/v3/documentation\n\n## First Successful Call\n\nOnce configured in your MCP client, start with:\n\n- `ping`\n- `pricing_get`\n\nThen try one read flow:\n\n- `dns_list` for your domain\n\nBefore any write call, run a scenario tool in `dry_run` mode first.\n\n## Safety Model\n\n- Write actions are blocked unless `--get-muddy` or `PORKBUN_GET_MUDDY=true` is set.\n- Scenario tools are designed to plan before apply.\n- Destructive tools include explicit limits and confirmations.\n- API credentials are account-level. Domain-level API permissions in Porkbun still apply.\n- Domain registration (`domains_create`) is disabled by default. It requires:\n - write mode (`--get-muddy`)\n - explicit enable flag (`--enable-domain-create` or `PORKBUN_ENABLE_DOMAIN_CREATE=true`)\n - `dry_run=false` + `confirm_apply=true` + `agree_to_terms=true`\n\n## Environment Variables\n\n- `PORKBUN_API_KEY` (required)\n- `PORKBUN_SECRET_KEY` (required)\n- `PORKBUN_GET_MUDDY` (optional)\n- `PORKBUN_ENABLE_DOMAIN_CREATE` (optional, dangerous)\n\n## CLI Options\n\n- `--get-muddy`\n- `--enable-domain-create` (dangerous)\n- `--transport stdio`\n- `--ipv4-only-api`\n- `--help`\n\n## What `--get-muddy` Means\n\n`--get-muddy` enables write mode.\n\nWithout it, the server stays in safe read-only behavior.\nWith it, mutating tools are allowed (create/edit/delete/update operations for DNS and domain settings).\n\nUse this mode only when:\n\n- you are ready to apply real infrastructure changes\n- your domain is API-enabled in Porkbun\n- you have already validated the plan with read calls or `dry_run` flows\n\n## Tool Coverage\n\n- Connectivity: `ping`, `pricing_get`\n- Domains: list, nameservers, URL forwarding, glue records (get/create/update/delete), availability\n- DNS: list/get/create/edit/delete (including by name/type)\n- DNSSEC: list/create/delete\n- SSL: certificate bundle retrieval\n\nScenario tools:\n\n- `dns_query`\n- `dns_upsert`\n- `domain_health_check`\n- `dns_remove`\n- `domain_redirect_ensure`\n- `domain_cutover_web`\n- `dns_batch_apply`\n\nBeginner helpers:\n\n- `dns_audit`\n- `dns_setup`\n- `email_dns_setup`\n- `update_server_ip`\n- `subdomain_setup`\n\nDetailed docs: [`docs/scenario-tools.md`](https://github.com/korobkov-v/porkbun-mcp/blob/main/docs/scenario-tools.md)\n\n## Practical Examples\n\n`dns_query` by record id:\n\n```json\n{\n \"domain\": \"example.com\",\n \"selector\": {\n \"record_id\": \"123456789\"\n }\n}\n```\n\n`dns_upsert` plan mode:\n\n```json\n{\n \"domain\": \"example.com\",\n \"match\": {\n \"type\": \"A\",\n \"subdomain\": \"www\"\n },\n \"target\": {\n \"content\": \"203.0.113.10\",\n \"ttl\": 300\n },\n \"dry_run\": true\n}\n```\n\n`domains_check_bulk`:\n\n```json\n{\n \"domains\": [\"example.com\", \"example.net\", \"example.org\"],\n \"concurrency\": 1,\n \"respect_limits\": true,\n \"delay_ms\": 11000,\n \"stop_on_rate_limit\": true\n}\n```\n\n`dns_batch_apply` plan:\n\n```json\n{\n \"domain\": \"example.com\",\n \"desired_records\": [\n {\n \"type\": \"A\",\n \"subdomain\": \"\",\n \"content\": \"198.51.100.42\",\n \"ttl\": 300\n }\n ],\n \"mode\": \"plan\",\n \"strategy\": \"merge\",\n \"max_changes\": 5\n}\n```\n\n## Security Notes\n\n- Never commit real API keys to git.\n- Prefer local environment variables or a secret manager.\n- Treat write mode as production access.\n\n## Development\n\n```bash\nnpm install\nnpm run build\n```\n\nRun locally:\n\n```bash\nnpm run dev\n```\n\n## Contributing\n\nContributions are welcome.\nRead [`CONTRIBUTING.md`](https://github.com/korobkov-v/porkbun-mcp/blob/main/CONTRIBUTING.md) before opening a PR.\n\n## License\n\nMIT\n","changelogMarkdown","videoKey","requiredSecretsJson","publishedAt","priceCents","trialDays",0,"iconType","image","upstream",{"_96":97,"_98":99,"_100":101,"_102":103,"_104":-5,"_105":106},"requiredSecrets",[],"tags",[],"assets",[],"stats",{"_94":81,"_95":81},"ratingAvg","reviewCount","topics",[],"license","MIT","language","TypeScript","registryName","io.github.korobkov-v/porkbun-mcp","homepage","packages",[107],{"_108":109,"_110":21,"_71":72},"registryType","npm","identifier","ENV",{"_113":114,"_115":116,"_117":118},"ENVIRONMENT","production","TURNSTILE_SITE_KEY","0x4AAAAAAB8-rEI2gNDf_QhU","SENTRY_DSN","https://45fd1229f78089d5c3ee78be128030e1@o4510583261757440.ingest.de.sentry.io/4510584253448272"]

Porkbun MCP