Phoenixd MCP Server

Phoenixd MCP サーバー

phoenixd のビットコイン Lightning ウォレットを LLM に接続します。

この MCP サーバーは、MCP TypeScript SDK と Phoenixd API を使用します。

前提条件

稼働中の phoenixd ノードが必要です。Phoenixd は初回起動時に HTTP パスワードを生成し、~/.phoenix/phoenix.conf に書き込みます。

http-password=your_generated_password

以下の設定で HTTP_PASSWORD にこの値を指定してください。

Node.js >= 18 が必要です。

設定

Claude Desktop での使用方法

claude_desktop_config.json ファイルに以下を追加してください。

{
  "mcpServers": {
    "phoenixd-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "phoenixd-mcp-server"
      ],
      "env": {
        "HTTP_PROTOCOL": "http",
        "HTTP_HOST": "127.0.0.1",
        "HTTP_PORT": "9740",
        "HTTP_PASSWORD": "<your_password_from_phoenix.conf>"
      }
    }
  }
}

リモートノード（VPS / HTTPS）

phoenixd が TLS 対応のリバースプロキシの背後にあるリモートサーバーで稼働している場合：

{
  "mcpServers": {
    "phoenixd-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "phoenixd-mcp-server"
      ],
      "env": {
        "HTTP_PROTOCOL": "https",
        "HTTP_HOST": "your.server.com",
        "HTTP_PORT": "9740",
        "HTTP_PASSWORD": "<your_password_from_phoenix.conf>"
      }
    }
  }
}

ツール

支払い

• create-invoice

  • 指定した金額と説明で bolt11 請求書を作成します。
  • 入力：
    • description（文字列、任意）：請求書の説明（最大 128 文字）。description または descriptionHash のいずれかを指定する必要があります。
    • descriptionHash（文字列、任意）：説明の SHA256 ハッシュ。description の代わりに使用します。
    • amountSat（数値、任意）：請求書で要求する金額（satoshi 単位）。設定しない場合、任意の金額で支払えます。
    • expirySeconds（数値、任意）：請求書の有効期限（秒）。デフォルトは 3600（1 時間）です。
    • externalId（文字列、任意）：請求書を外部システムに関連付けるカスタム識別子です。
    • webhookUrl（文字列、任意）：この請求書の支払い時に phoenixd が POST する URL です。ペイロードは、Phoenixd API のドキュメントで定義されている支払い詳細を含む JSON オブジェクトです。

• create-offer

  • bolt12 オファーを作成します。
  • 入力：
    • description（文字列）：オファーの説明です。
    • amountSat（数値、任意）：オファーで要求する金額（satoshi 単位）です。
    • expirySeconds（数値、任意）：オファーの有効期限（秒）です。

• pay-invoice

  • bolt11 請求書に支払います。
  • 入力：
    • invoice（文字列）：支払い対象の bolt11 請求書です。
    • amountSat（数値、任意）：支払う金額（satoshi 単位）です（ゼロ金額の請求書の場合のみ）。sendAll とは同時に指定できません。
    • sendAll（ブール値、任意）：true の場合、ウォレットの全残高を送金します。amountSat とは同時に指定できません。
    • externalId（文字列、任意）：支払いを外部システムに関連付けるカスタム識別子です。

• pay-offer

  • bolt12 オファーに支払います。
  • 入力：
    • offer（文字列）：支払い対象の bolt12 オファーです。
    • amountSat（数値、任意）：支払う金額（satoshi 単位）です。sendAll とは同時に指定できません。
    • sendAll（ブール値、任意）：true の場合、ウォレットの全残高を送金します。amountSat とは同時に指定できません。
    • message（文字列、任意）：受取人へのメッセージです。
    • externalId（文字列、任意）：支払いを外部システムに関連付けるカスタム識別子です。

• pay-lightning-address

  • Lightning Address に支払います。
  • 入力：
    • address（文字列）：支払い対象の Lightning Address（例：[email protected]）です。
    • amountSat（数値、任意）：支払う金額（satoshi 単位）です。sendAll とは同時に指定できません。
    • sendAll（ブール値、任意）：true の場合、ウォレットの全残高を送金します。amountSat とは同時に指定できません。
    • message（文字列、任意）：支払いに含める任意のメッセージです。

• pay-on-chain

  • オンチェーンの Bitcoin 支払いを送金します。
  • 入力：
    • address（文字列）：資金の送金先となる Bitcoin アドレスです。
    • amountSat（数値）：送金する金額（satoshi 単位）です。
    • feerateSatByte（数値、任意）：1 バイトあたりの手数料率（satoshi 単位）です。

• bump-fee

  • CPFP を使用して、未確認のオンチェーントランザクションすべての手数料率を引き上げます。子トランザクションの ID を返します。
  • 入力：
    • feerateSatByte（数値）：新しい手数料率（1 バイトあたりの satoshi 単位）です。

• list-incoming-payments

  • 入金（請求書）を一覧表示します。
  • 入力：
    • from（string、任意）：エポックからの開始時刻（ミリ秒）。デフォルトは 0 です。
    • to（string、任意）：エポックからの終了時刻（ミリ秒）。デフォルトは現在時刻です。
    • limit（number、任意）：1 ページあたりの入金数。デフォルトは 20 です。
    • offset（number、任意）：ページオフセット。デフォルトは 0 です。
    • all（boolean、任意）：未払いの請求書も返すかどうか。デフォルトは false です。
    • externalId（string、任意）：bolt11 請求書の外部 ID です。

• get-incoming-payment

  • 特定の入金（請求書）の詳細を取得します。
  • 入力：
    • paymentHash（string）：請求書の支払いハッシュです。

• list-outgoing-payments

  • 出金を一覧表示します。
  • 入力：
    • from（string、任意）：エポックからの開始時刻（ミリ秒）。デフォルトは 0 です。
    • to（string、任意）：エポックからの終了時刻（ミリ秒）。デフォルトは現在時刻です。
    • limit（number、任意）：1 ページあたりの出金数。デフォルトは 20 です。
    • offset（number、任意）：ページオフセット。デフォルトは 0 です。
    • externalId（string、任意）：出金の外部 ID です。

• get-outgoing-payment

  • 特定の出金の詳細を取得します。
  • 入力：
    • paymentHash（string）：出金の支払いハッシュです。

ノード管理

• get-node-info

  • ノード情報を取得します。
  • 入力：なし

• get-balance

  • ノードの残高を取得します。
  • 入力：なし

• list-channels

  • ノードのチャネルを一覧表示します。
  • 入力：なし

• close-channel

  • チャネル ID を指定してチャネルを閉じ、指定した手数料率でオンチェーンの指定アドレスに資金を送金します。
  • 入力：
    • channelId（string）：閉じるチャネルの ID です。
    • address（string）：資金の送金先となる Bitcoin オンチェーンアドレスです。
    • feerateSatByte（number）：バイトあたりのサトシで指定する手数料率です。

• decode-invoice

  • bolt11 請求書をデコードします。出力金額の単位はミリサトシです。
  • 入力：
    • invoice（string）：デコードする bolt11 請求書です。

• decode-offer

  • bolt12 オファーをデコードします。出力金額の単位はミリサトシです。
  • 入力：
    • offer（string）：デコードする bolt12 オファーです。

トラブルシューティング

Authentication failed / 401 — HTTP_PASSWORD が ~/.phoenix/phoenix.conf の値と一致していることを確認してください。

Connection refused — Phoenixd が実行されていないか、別のホスト／ポートでリッスンしています。curl http://127.0.0.1:9740/getinfo -u :your_password で確認してください。

Node.js version error — このパッケージには Node.js >= 18 が必要です。node --version を実行して確認してください。