Phoenixd MCP Server

by Sharmaz

271 downloads

Not rated

GitHub

Other

About

Connect a phoenixd bitcoin lightning wallet to your LLM.

Details

Author: Sharmaz
Downloads: 271
Categories: Other

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name Phoenixd MCP Server

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

From the repository

Configure the server in claude_desktop_config.json using npx -y phoenixd-mcp-server and set the environment variables HTTP_PROTOCOL, HTTP_HOST, HTTP_PORT, and HTTP_PASSWORD. Once connected, the LLM can call any of the server’s tools to interact with the phoenixd wallet.

`get-balance`

Get the balance of the node

`get-node-info`

Get the node info

`list-channels`

List the node channels

`close-channel`

Close a channel by ID, sending the funds to a specified address on chain, with a specified fee rate

`decode-invoice`

Decode an bolt11 invoice, the output amount is in milisatoshis

`decode-offer`

Decode an bolt12 offer the output amount is in milisatoshis

`create-invoice`

Create a bolt11 invoice with a specified amount and description

`pay-invoice`

Pay a bolt11 invoice with a specified amount and description

`create-offer`

Create a bolt12 offer with an optional description and amount

`pay-offer`

Pay a bolt12 offer

`pay-lightning-address`

Pays an email-like Lightning address, either based on BIP-353 or LNURL

`pay-on-chain`

Pay an on-chain address with a specified amount and fee rate

`bump-fee`

Makes all your unconfirmed transactions use a higher fee rate, using CPFP. Returns the ID of the child transaction

`list-incoming-payments`

List the incoming payments

`get-incoming-payment`

Get the incoming payment by payment hash

`list-outgoing-payments`

List the outgoing payments

`get-outgoing-payment`

Get the outgoing payment by payment id

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "phoenixd mcp server": {
            "phoenixd-mpc-server": {
                "command": "npx",
                "args": [
                    "-y",
                    "phoenixd-mcp-server"
                ],
                "env": {
                    "HTTP_PROTOCOL": "<http or https>",
                    "HTTP_HOST": "<your_host>",
                    "HTTP_PORT": "<your_phoenixd_port>",
                    "HTTP_PASSWORD": "<phoenixd_http_password>"
                }
            }
        }
    }
}

McpServers

{
    "phoenixd-mpc-server": {
        "command": "npx",
        "args": [
            "-y",
            "phoenixd-mcp-server"
        ],
        "env": {
            "HTTP_PROTOCOL": "<http or https>",
            "HTTP_HOST": "<your_host>",
            "HTTP_PORT": "<your_phoenixd_port>",
            "HTTP_PASSWORD": "<phoenixd_http_password>"
        }
    }
}

Phoenixd MCP Server

Connect a phoenixd bitcoin lightning wallet to your LLM.

This MCP server uses MCP TypeScript SDK and Phoenixd API.

Configuration

Usage with Claude Desktop

Add this to your claude_desktop_config.json file:

{
  "mcpServers": {
    "phoenixd-mpc-server": {
      "command": "npx",
      "args": [
        "-y",
        "phoenixd-mcp-server"
      ],
      "env": {
        "HTTP_PROTOCOL": "<http or https>",   // If not set http is the default value.
        "HTTP_HOST": "<your_host>",           // 127.0.0.1 or your-domain.com
        "HTTP_PORT": "<your_phoenixd_port>",  // If not set 9740 is the default port.
        "HTTP_PASSWORD": "<phoenixd_http_password>"
      }
    }
  }
}

Tools

Payments

- create-invoice
- Create a bolt11 invoice with a specified amount and description.
- Inputs:
- description (string): The description of the invoice (max. 128 characters).
- amountSat (number, optional): The amount requested by the invoice, in satoshi. If not set, the invoice can be paid by any amount.
- expirySeconds (number, optional): The invoice expiry in seconds, default 3600 (1 hour).
- externalId (string, optional): A custom identifier to link the invoice to an external system.
- webhookUrl (string, optional): A webhook URL to be notified when this payment is received.

- create-offer
- Create a bolt12 offer. [Not Available]
- Inputs:
- description (string): The description of the offer.
- amountSat (number, optional): The amount requested by the offer, in satoshi.
- expirySeconds (number, optional): The offer expiry in seconds.

- pay-invoice
- Pay a bolt11 invoice.
- Inputs:
- invoice (string): The bolt11 invoice to pay.
- amountMsat (number, optional): Amount to pay in millisatoshis (only for zero-amount invoices).
- externalId (string, optional): A custom identifier to link the payment to an external system.

- pay-offer
- Pay a bolt12 offer.
- Inputs:
- offer (string): The bolt12 offer to pay.
- amountMsat (number): Amount to pay in millisatoshis.
- externalId (string, optional): A custom identifier to link the payment to an external system.

- pay-lightning-address
- Pay a Lightning Address.
- Inputs:
- address (string): The Lightning Address to pay (e.g., swamppawpaw18@phoenixwallet.me).
- amountSat (number): Amount to pay in satoshis.
- comment (string, optional): Optional comment to include with the payment.

- pay-on-chain
- Send an on-chain Bitcoin payment.
- Inputs:
- address (string): The Bitcoin address to send funds to.
- amountSat (number): Amount to send in satoshis.
- feerateSatByte (number, optional): Fee rate in satoshis per byte.

- bump-fee
- Bump the fee of an unconfirmed on-chain transaction.
- Inputs:
- txId (string): The transaction ID to bump.
- feerateSatByte (number): New fee rate in satoshis per byte.

- list-incoming-payments
- List incoming payments (invoices).
- Inputs:
- from (string, optional): Start timestamp in millis from epoch, default 0.
- to (string, optional): End timestamp in millis from epoch, default now.
- limit (number, optional): Number of payments per page, default 20.
- offset (number, optional): Page offset, default 0.
- all (boolean, optional): Also return unpaid invoices, default false.
- externalId (string, optional): External id of the bolt11 invoice.

- get-incoming-payment
- Get details of a specific incoming payment (invoice).
- Inputs:
- paymentHash (string): The payment hash of the invoice.

- list-outgoing-payments
- List outgoing payments.
- Inputs:
- from (string, optional): Start timestamp in millis from epoch, default 0.
- to (string, optional): End timestamp in millis from epoch, default now.
- limit (number, optional): Number of payments per page, default 20.
- offset (number, optional): Page offset, default 0.
- externalId (string, optional): External id of the payment.

- get-outgoing-payment
- Get details of a specific outgoing payment.
- Inputs:
- paymentHash (string): The payment hash of the outgoing payment.

Node management

- get-node-info
- Get the node info.
- Inputs: none

- get-balance
- Get the balance of the node.
- Inputs: none

- list-channels
- List the node channels.
- Inputs: none

- close-channel
- Close a channel by ID, sending the funds to a specified address on chain, with a specified fee rate.
- Inputs:
- channelId (string): The ID of the channel to close.
- address (string): The Bitcoin on chain address to send the funds to.
- feerateSatByte (number): The fee rate in satoshis per byte.

- decode-invoice
- Decode an bolt11 invoice, the output amount is in milisatoshis.
- Inputs:
- invoice (string): The bolt11 invoice to decode.

- decode-offer
- Decode an bolt12 offer, the output amount is in milisatoshis.
- Inputs:
- offer (string): The bolt12 offer to decode.

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

get-balance

get-node-info

list-channels

close-channel

decode-invoice

decode-offer

create-invoice

pay-invoice

create-offer

pay-offer

pay-lightning-address

pay-on-chain

bump-fee

list-incoming-payments

get-incoming-payment

list-outgoing-payments

get-outgoing-payment

Claude Desktop / Cursor

McpServers

Phoenixd MCP Server

Configuration

Usage with Claude Desktop

Tools

Payments

Node management

Install

More like this

Sequential Thinking

Filesystem

EverArt

Google Drive

Reactive Resume

FastMCP v2 🚀

`get-balance`

`get-node-info`

`list-channels`

`close-channel`

`decode-invoice`

`decode-offer`

`create-invoice`

`pay-invoice`

`create-offer`

`pay-offer`

`pay-lightning-address`

`pay-on-chain`

`bump-fee`

`list-incoming-payments`

`get-incoming-payment`

`list-outgoing-payments`

`get-outgoing-payment`