Bitcoin MCP Lsn

🚀 Bitcoin MCP Server

A Go-based service that provides a unified interface to interact with Bitcoin nodes through various RPC commands using the Model Context Protocol (MCP). This server organizes Bitcoin RPC functionality into logical categories and offers a clean, well-documented API for accessing blockchain data and operations.

🚀 Quick Start

The Bitcoin MCP Server is a powerful tool for interacting with Bitcoin nodes. It streamlines the process of accessing blockchain data and performing operations through a clean and well-documented API.

✨ Features

• Comprehensive Bitcoin RPC interface using the Model Context Protocol
• Categorized by functionality:
  • Blockchain operations
  • Mempool operations
  • UTXO operations
  • Blockchain management
• Secure authentication
• Comprehensive error handling
• Clean and well-documented API

📦 Installation

Prerequisites

• Go 1.24 or higher
• A Bitcoin Core node with RPC enabled
• A basic understanding of Bitcoin RPC commands

Steps

1. Clone the repository:

git clone https://github.com/moncho/bitcoin-mcp.git
cd bitcoin-mcp

2. Install dependencies:

go mod download

3. Build the server:

go build -o bitcoin-mcp

💻 Usage Examples

Configuration

Create a configuration file (config.json) with the following structure:

{
    "bitcoin": {
        "rpc_url": "http://localhost:8332",
        "username": "your_rpc_username",
        "password": "your_rpc_password"
    },
    "server": {
        "port": 8080,
        "host": "localhost"
    }
}

Running the Server

1. Start your Bitcoin Core node with RPC enabled:

bitcoind -server -rpcuser=your_rpc_username -rpcpassword=your_rpc_password

2. Start the MCP server:

./bitcoin-mcp -config config.json

Or use environment variables:

BITCOIN_RPC_URL=http://localhost:8332 \
BITCOIN_RPC_USER=your_rpc_username \
BITCOIN_RPC_PASS=your_rpc_password \
./bitcoin-mcp

API Usage

The server provides a RESTful API for accessing Bitcoin RPC commands. Here are some examples:

Basic Usage

Get blockchain information

curl -X POST http://localhost:8080/api/v1/blockchain/info

Get block data

curl -X POST http://localhost:8080/api/v1/blockchain/block \
  -H "Content-Type: application/json" \
  -d '{"blockhash": "0000000000000000000123456789abcdef", "verbose": true}'

Get mempool information

curl -X POST http://localhost:8080/api/v1/mempool/info

🔧 Technical Details

Project Structure

bitcoin-mcp/
├── cmd/
│   └── server/          # Main server application
├── pkg/
│   ├── bitcoin/         # Bitcoin RPC client
│   └── tools/           # RPC command implementation
├── config.json          # Configuration file
└── README.md           # This file

Adding New RPC Commands

1. Add methods to the Bitcoin RPC client in pkg/bitcoin/client.go.
2. Implement new command handling logic in the pkg/tools/ directory.
3. Update the routes to handle new commands:
   • Add new routes to server/main.go.
   • Implement new handler functions.

Example: Adding a Block Explorer Command

1. Create a new tool file:

package tools

import (
    "encoding/json"
    "log"
    "net/http"

    "github.com/moncho/bitcoin-mcp/pkg/api"
)

func BlockExplorer(w http.ResponseWriter, r *http.Request) {
    // Get block hash
    blockHash := getBlockHashFromRequest(r)
    
    // Get block details
    blockData, err := api.GetBlockDetails(blockHash)
    if err != nil {
        log.Printf("Failed to get block details: %v", err)
        w.WriteHeader(http.StatusInternalServerError)
        return
    }

    // Return JSON response
    w.Header().Set("Content-Type", "application/json")
    json.NewEncoder(w).Encode(blockData)
}

2. Update the main file to add the route:

package main

import (
    "log"
    
    "github.com/moncho/bitcoin-mcp/pkg/tools"
)

func main() {
    // Start the server and register routes
    http.HandleFunc("/api/v1/block/explorer", tools.BlockExplorer)
    log.Fatal(http.ListenAndServe(":8080", nil))
}

📚 Documentation

Security Considerations

• Avoid exposing sensitive information, such as API keys, in logs or error messages.
• Use HTTPS to secure API communication and enable TLS encryption by default.
• Rotate API keys and certificates regularly to reduce the risk of unauthorized access.
• Configure rate limiting and authentication mechanisms to prevent abuse and denial-of-service attacks.

Contribution Guidelines

1. Fork the repository: Bitcoin-MCP
2. Create a feature branch:

git checkout -b feature/new-command

3. Commit your changes and create a pull request.
4. Participate in issue discussions and community contributions.

📄 License

This project is open-source under the MIT License. You are welcome to use and distribute it freely.

Contact

• Email: contact@bitcoin-mcp.com
• Repository: Bitcoin-MCP
• Forum: Bitcoin-MCP Discussion