Porkbun-MCP

# Porkbun MCP Server (official)

[![npm version](https://img.shields.io/npm/v/@porkbunllc/mcp-server.svg?color=cb3837&label=npm)](https://www.npmjs.com/package/@porkbunllc/mcp-server)
[![npm downloads](https://img.shields.io/npm/dm/@porkbunllc/mcp-server.svg)](https://www.npmjs.com/package/@porkbunllc/mcp-server)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**The official MCP server from Porkbun, built and maintained by Porkbun** (by [Owen Borseth](https://github.com/oborseth), Porkbun's CTO). It is published on npm as [`@porkbunllc/mcp-server`](https://www.npmjs.com/package/@porkbunllc/mcp-server) and hosted by Porkbun at `https://mcp.porkbun.com/mcp`. Other "Porkbun MCP" projects on GitHub and in MCP directories are community wrappers around the public API; they are not made or supported by Porkbun. In the [official MCP Registry](https://registry.modelcontextprotocol.io) it is listed as **`com.porkbun/mcp`**, a name the registry grants only to whoever proves control of porkbun.com; community projects appear under `io.github.*` names.

A [Model Context Protocol](https://modelcontextprotocol.io) server that exposes the [Porkbun v3 API](https://porkbun.com/api/json/v3/documentation) as native tools for AI agents — Claude Desktop, Cursor, Cline, and any other MCP-compatible client.

**Setup guide, client configs and the full tool list: [porkbun.com/mcp](https://porkbun.com/mcp)**

**No install: use the hosted connector.** Porkbun runs this server at `https://mcp.porkbun.com/mcp`. Add that URL as a custom connector in ChatGPT or Claude (or `claude mcp add --transport http porkbun https://mcp.porkbun.com/mcp` in Claude Code), sign in to Porkbun and approve. No API key to copy. Steps per client: [Connect ChatGPT or Claude](https://porkbun.com/llms/guides/connect-chatgpt-or-claude). How it is deployed: [`deploy/README.md`](deploy/README.md). The ChatGPT and Claude directory listings use a narrower variant, `/mcp/no-purchases` (no tool that spends money or returns a secret); it changes which tools are offered, not what a connection may do.

> **Status:** full Porkbun v3 coverage (domains, DNS, SSL, hosting, webhooks; current version on the npm badge above). Also runs **hosted** at `https://mcp.porkbun.com/mcp` for ChatGPT and Claude, with sign-in instead of API keys. Provisions **Cloud for WordPress** and mints WordPress REST API credentials so an agent can manage the site it just created. Moves domains to a customer's **own Cloudflare account** and then manages those records, the proxy and zone settings. An isolated **sandbox**: a `pk1_sb_` key runs every tool against a simulated environment with fake credit — no real registry actions, DNS changes or charges — and still delivers signed webhooks. A credential-free **mock server** returns schema-accurate example responses for any endpoint.

## What's included

**Read tools (free, no spend, no state changes)**

| Tool | Description |
|---|---|
| `ping` | Verify API connectivity and credentials |
| `check_domain` | Check availability and pricing for a single domain |
| `get_registration_requirements` | TLD registration requirements as JSON Schema — is it API-registerable, the create payload, and registry eligibility fields (.us nexus, .ca legal type, …) |
| `get_pricing` | Get registration/renewal/transfer pricing for all TLDs (no auth needed) |
| `list_marketplace` | Browse the Porkbun aftermarket — filter by TLD, max price, name substring |
| `search_closeouts` | Search expired-domain closeouts; filter by age, price, TLD, name length; sort by registration date |
| `get_closeout` | One closeout plus its binding total (closeout price + the renewal/transfer year) |
| `buy_closeout` | Buy a closeout outright. **Spends account credit** |
| `list_domains` | Paginate through domains; filter by tld, expiry, auto-renew, API access |
| `get_domain` | Get metadata for a single domain in the account |
| `get_balance` | Get account credit balance |
| `get_auto_topup` | Read auto top-up settings, whether a card is on file, and what a top-up would charge |
| `get_api_settings` | Get monthly spend limit, low-balance alert, auto top-up config, MTD spend |
| `get_nameservers` | Get current nameservers for a domain |
| `list_dns_records` | List DNS records for a domain |
| `scan_dns_records` | Discover what a domain publishes now, from its live nameservers (use before a transfer — a transfer carries no zone data) |
| `import_dns_records` | Bulk-create records from a supplied list or a live scan; idempotent, already-present records are skipped |
| `list_dnssec_records` | List DNSSEC DS records published at the registry |
| `list_url_forwards` | List URL forwarding rules for a domain (incl. exact `redirectType`: 301/302/307/masked) |
| `list_glue_records` | List glue records (host-to-IP mappings) for a domain |
| `list_transfers` | List in-progress and recent inbound transfers |
| `get_transfer_status` | Get status of a specific inbound transfer |
| `get_ssl_bundle` | Retrieve the free Porkbun-issued SSL bundle for a domain |
| `get_contacts` | Get a domain's four contacts (registrant/admin/tech/billing) with current values |
| `get_webhook_event_types` | List the event types a webhook endpoint can subscribe to |
| `list_webhooks` | List webhook endpoints (URL, events, status, delivery health, secret) |
| `get_webhook` | Get a single webhook endpoint by id |
| `list_webhook_deliveries` | List recent delivery attempts (status, attempts, HTTP, error); ~30-day history |
| `get_webhook_delivery` | Get a single delivery incl. the full signed payload |
| `list_doc_topics` | List Porkbun API doc topics (the docs index) |
| `read_doc` | Read a doc page as Markdown (`dns`, `webhooks`, … or `overview`/`full`) |
| `search_docs` | Keyword-search the full reference; returns the most relevant sections |

The `list_doc_topics` / `read_doc` / `search_docs` tools let an agent ground itself in Porkbun's own documentation (the `/llms` Markdown surface) mid-conversation — no web browsing required, and **no API credentials needed**. You can add the server purely to research the API, then supply keys when you're ready for live operations.

**Account funding (charges a saved card, not credit)**

| Tool | What it does |
|------|--------------|
| `configure_auto_topup` | Turn auto top-up on/off: below `threshold_cents`, add `amount_cents` from the saved payment method. Amounts set via the API are capped at $500 |
| `top_up_account_credit` | **Charges the saved card now** and adds the credit. Omit `amount_cents` for the account's configured amount (or $50 if never set), or pass `amount_cents` (500-50000) for a one-off figure. Ask the user first, in dollars. 5/day, 20/month, within the monthly spend limit |

**Domain lifecycle writes (spend account credit)**

| Tool | Description |
|---|---|
| `register_domain` | Register a new domain — call `check_domain` first to confirm price |
| `renew_domain` | Renew an existing domain |
| `transfer_domain` | Initiate an inbound transfer (returns transferId; takes 5-7 days) |
| `get_transfer_setup` | Where a held inbound transfer is and what it is waiting on |
| `prepare_transfer` | Create the DNS zone for a held transfer, before the domain moves |
| `start_transfer` | Release a held transfer to the registry (refuses on an empty zone) |
| `cancel_transfer` | Cancel a pending inbound transfer and refund it |
| `update_transfer_auth_code` | Replace the auth code on a stalled transfer and re-queue it |

**Domain settings writes (free)**

| Tool | Description |
|---|---|
| `update_auto_renew` | Turn auto-renewal on or off |
| `update_nameservers` | Replace the nameserver list for a domain (full replace, not append) |
| `update_contacts` | Edit domain contacts — any subset of registrant/admin/tech/billing; a registrant change fires the new-owner notice email. On address-validated TLDs (`.de`/`.nrw`/`.uk`/`.us`/`.ca`/`.au`/`.eu`/`.in`/`.nz` families) it validates the registrant address — resolve with `address_validation_choice`. A `.au` registrant name/org change is a website-only ownership trade. |

**DNS / DNSSEC / URL-forwarding / glue writes (free)**

| Tool | Description |
|---|---|
| `create_dns_record` | Create a new DNS record (A, AAAA, CNAME, MX, TXT, etc.) |
| `update_dns_record` | Update an existing DNS record by its ID |
| `delete_dns_record` | Delete a DNS record by its ID |
| `create_dnssec_record` | Submit a DNSSEC DS record to the registry |
| `delete_dnssec_record` | Remove a DNSSEC DS record by key tag |
| `create_url_forward` | Create a URL forwarding rule (permanent/temporary/masked; optional `redirect_type` 301/302/307/masked) |
| `delete_url_forward` | Delete a URL forwarding rule by ID |
| `create_glue_record` | Create a glue record (host-to-IP mapping at the registry) |
| `update_glue_record` | Replace the IP list for a glue record |
| `delete_glue_record` | Delete a glue record by host |

**Secure Static Hosting**

| Tool | Description |
|---|---|
| `list_hosting_plans` | List API-provisionable hosting products + plans, with price (cents), interval, trial length, features |
| `create_hosting` | Provision hosting for a domain by `sku` (from `list_hosting_plans`) — first provision per domain is a 15-day free trial that auto-renews at the plan price; re-provision after deprovision is charged to account credit (one free trial per domain). Switches the domain to Porkbun NS (gated by `agree_to_nameserver_change`); requires `acknowledged_cost`. `dry_run` supported |
| `get_hosting` | Get hosting status for a domain (plan, trial, expiry, auto-renew) |
| `deploy_site` | Upload static files (base64, ≤10MB/call) to a domain's hosting |
| `list_hosting_files` | List files under a path in a domain's hosting |
| `delete_hosting_file` | Delete a file (or empty dir) from a domain's hosting |
| `make_hosting_dir` | Create a directory (and missing parents) in a domain's hosting (deploy auto-creates dirs in a fil