Zbd MCP Server

🚀 ZBD MCP Server

This project has been deprecated. Please switch to: https://github.com/zebedeeio/zbd-payments-typescript-sdk/tree/main/packages/mcp-server

Add Bitcoin functionality to your Large Language Model (LLM).

🚀 Quick Start

Prerequisites

• Node.js 23+ (or Bun/Deno/any environment that can run .ts files)
• Bun (for building executable files)
• ZBD API key for payment processing

ZBD Setup

Get your API key from the ZBD developer console and add it to a new .env file in the project root directory in the format ZBD_API_KEY=XXXXXXXXXXXX (refer to .env.example as an example). After configuration, run the pnpm build command and set up the MCP server on your client (e.g., Claude Desktop or Cursor).

Installing Bun

If you haven't installed Bun, use one of the following methods:

macOS and Linux

# Using curl (recommended)
curl -fsSL https://bun.sh/install | bash

# Using Homebrew
brew install oven-sh/bun/bun

# Using npm
npm install -g bun

Windows

# Using PowerShell
powershell -c "irm bun.sh/install.ps1|iex"

# Using npm
npm install -g bun

# Using Scoop
scoop install bun

Verify the installation by running:

bun --version

Installation

pnpm install

✨ Features

This MCP server uses the official TypeScript SDK — https://github.com/modelcontextprotocol/typescript-sdk

📦 Installation

pnpm install

💻 Usage Examples

Initializing the Environment

1. Create a .env file and add the ZBD_API_KEY.
2. Install dependencies: pnpm install

Starting the Server

pnpm dev

Stopping the Server

Ctrl + C

📚 Documentation

Troubleshooting

• Use ps aux | grep mcp-zbd | grep -v "grep" to view processes.
• Use lsof -i :3000 or other ports to find occupied processes.

Project Structure

.
├── .env.example         # Example file for environment variables
├── src                 # Source code directory
│   ├── index.ts        # Entry file
│   └── utils           # Utility functions
└── package.json       # Project dependencies and configuration

Provided Tools

Here is a list of all the features supported by the MCP server:

1. Send Lightning Network Payments - Send Bitcoin to one or more Lightning addresses.
2. Send Bulk Lightning Network Payments - Send Bitcoin to multiple Lightning addresses in a single request.
3. Create a Charge - Create a new Bitcoin Lightning Network charge.
4. Get a Charge - Get all data about a single charge.
5. Decode a Charge - Understand the internal attributes of a charge QR code.
6. Send a Payment - Send a Bitcoin Lightning Network payment.
7. Get a Payment - Get all data about a single payment.
8. Create a Withdrawal Request - Create a Bitcoin withdrawal QR code.
9. Get a Withdrawal Request - Get all data about a single withdrawal request.
10. Revoke a Withdrawal Request - Revoke a valid withdrawal request and retrieve funds to the project wallet.
11. Send an Email Payment - Send an instant Bitcoin payment to any email address.
12. Create a Coupon - Create a one-time ZBD coupon that can be used by any ZBD user.
13. Get a Coupon - Get all data about a single coupon.
14. Redeem a Coupon - Redeem a ZBD coupon for credits in the project wallet.
15. Internal Transfer - Transfer funds between two projects.
16. Check Supported Regions - Verify if a user is from a supported region.
17. Get ZBD IP Address - Get the official IP address of the ZBD server.
18. Create a Withdrawal Request - Create a Bitcoin withdrawal QR code.
19. Internal Transfer - Transfer funds between two projects.
20. Create a Coupon - Create a one-time ZBD coupon that can be used by any ZBD user.
21. Get a Coupon - Get all data about a single coupon.
22. Redeem a Coupon - Redeem a ZBD coupon for credits in the project wallet.
23. revoke-voucher - Revoke a valid withdrawal request and retrieve funds to the project wallet.

📄 License

No license information provided.

⚠️ Important Note

All API requests require a valid ZBD_API_KEY. Ensure the server runs in a secure environment to avoid exposing the API key.