JinDaGe - porkbun-mcp-server MCP Details

article

README

🚀 猪肉 bun MCP 服务器

这个仓库包含了一个用于与 Porkbun 域名注册商交互的 Miracle Custom Protocol (MCP) 服务器。借助该服务器，你能够通过 Claude Desktop 应用或其他兼容工具对 Porkbun 域名进行自动化管理。

✨ 主要特性

该实现目前支持以下操作：

域名管理
- 购买域名
- 注销域名
- 刷新域名状态
- 获取所有注册的域名列表
DNS 记录管理
- 获取当前 DNS 设置
- 添加新的 DNS 记录（A、AAAA、CNAME、MX、TXT）
- 更新现有 DNS 记录
- 删除 DNS 记录
隐私保护
- 启用/禁用域名隐私保护

更多功能正在开发中，如 SSL 证书管理、Whois 隐私保护等。

📦 安装指南

克隆仓库

git clone https://github.com/miraclebakelaser/porkbun-mcp-server.git
cd porkbun-mcp-server

安装依赖项

npm install

配置 API 密钥

你可以通过多种方式提供 Porkbun 的 API Key 和 Secret Key（按优先级从高到低）：

系统环境变量：设置 PORKBUN_API_KEY 和 PORKBUN_SECRET_API_KEY 系统环境变量。
自定义 .env 文件：创建一个任意位置的 .env 文件，并通过命令行参数指定其路径（参见运行服务器部分）。
默认 .env 文件：在项目根目录下创建名为 porkbun-mcp-server/.env 的文件，内容如下：

PORKBUN_API_KEY=YOUR_API_KEY
PORKBUN_SECRET_API_KEY=YOUR_SECRET_API_KEY

请将 YOUR_API_KEY 和 YOUR_SECRET_API_KEY 替换为你的实际密钥。

⚠️ 重要提示

如果计划将此项目提交到版本控制系统，请将 .env 文件添加到 .gitignore 中。

🚀 快速开始

编译

将 TypeScript 代码编译为 JavaScript：

npm run build

这将在 build/ 目录下生成可执行的 JavaScript 文件。

运行服务器

你可以直接使用 Node.js 运行编译后的服务器。

标准启动方式：使用默认 .env 文件或系统环境变量：

npm start
# 或直接运行：
node build/index.js

自定义 .env 路径启动：通过 --dotenv-path 或 -p 命令行参数指定 .env 文件路径：

node build/index.js --dotenv-path /path/to/your/.env
# 或简写为：
node build/index.js -p /path/to/your/.env

开发模式：使用 dev 脚本监视文件变化并自动重建和重启：

# 默认 `.env` 启动
npm run dev

# 自定义 `.env` 路径启动
npm run dev -- --dotenv-path /path/to/your/.env
# 或
npm run dev -- -p /path/to/your/.env

服务器使用 MCP stdio 传输协议（标准输入输出）进行通信。

在 Claude Desktop 中使用

要将此服务器与 Claude Desktop 应用一起使用，请在 "mcpServers" 配置下添加以下内容：

"Porkbun":
{
  "name": "Porkbun",
  "type": "custom",
  "url": "file://path/to/porkbun-mcp-server/build/index.js"
}

确保服务器保持运行状态，Claude Desktop 将自动连接。

📚 详细文档

完整的 API 文档可以在 MCP 协议仓库中找到。

📄 许可证

MIT License

版权 (c) 2023年 miraclebakelaser

特此许可任何个人和组织使用、复制、修改、合并、发布、分发、 sublicense，以及制造和销售 derivative works 的权利，但需遵守以下条件：

1. 在分发或发表的衍生作品中保留上述版权声明、本许可声明以及下文中的免责声明。
2. 不对保修承担任何责任。

由于软件有可能存在缺陷，导致任何形式的损害或其他问题（包括但不限于直接、间接、附带或后果性损害），作者或版权持有人概不负责。

此文档为 Porkbun MCP 服务器的使用和配置指南，翻译自官方文档。

porkbun-mcp-server