Porkbun MCP Server

🚀 豚肉バン MCP サーバー

このリポジトリには、Porkbun ドメイン登録業者とやり取りするための Miracle Custom Protocol (MCP) サーバーが含まれています。このサーバーを使用すると、Claude Desktop アプリやその他の互換性のあるツールを通じて自動化管理を行うことができます。

✨ 主な機能

この実装では、現在以下の操作がサポートされています。

• ドメイン管理
  • ドメインの購入
  • ドメインの解約
  • ドメインの状態を更新
  • 登録済みのすべてのドメインのリストを取得
• 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 は、以下の方法で提供できます（優先度の高い順）。

1. システム環境変数：PORKBUN_API_KEY と PORKBUN_SECRET_API_KEY システム環境変数を設定します。
2. カスタム .env ファイル：任意の場所に .env ファイルを作成し、コマンドライン引数でそのパスを指定します（サーバーの起動に関するセクションを参照）。
3. デフォルトの .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 アプリとこのサーバーを一緒に使用するには、"mcpServers" 設定の下に以下の内容を追加します。

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

サーバーが実行されていることを確認してください。Claude Desktop は自動的に接続します。

📚 ドキュメント

完全な API ドキュメントは、MCP プロトコル リポジトリで見つけることができます。

📄 ライセンス

MIT License

Copyright (c) 2023年 miraclebakelaser

以下の条件に従うことを条件として、個人および組織に対して、使用、複製、修正、統合、公開、配布、サブライセンス、および派生作品の製造と販売の権利が許可されます。

1. 配布または公開される派生作品に、上記の著作権表示、本ライセンス表示、および以下の免責事項を含めること。
2. 保証に関する責任を負わないこと。

ソフトウェアに欠陥がある可能性があり、それによって直接的、間接的、付随的または結果的な損害を含む、あらゆる形式の損害やその他の問題が発生する可能性がありますが、作者または著作権者は一切の責任を負いません。

このドキュメントは、Porkbun MCP サーバーの使用と設定ガイドであり、公式ドキュメントから翻訳されています。