Goldrush MCP Server

🚀 Golden Rush Model Context Protocol Server

The Golden Rush MCP (Model Context Protocol) Server is a tool for connecting and managing blockchain data. It offers multiple service modules that can handle tasks such as balance queries, transaction analysis, and NFT data processing.

🚀 Quick Start

✨ Features

• Connect and manage blockchain data.
• Provide multiple service modules for various blockchain - related tasks.

📦 Installation

Prerequisites

• Node.js version 18 or higher.
• npm, yarn, or pnpm.
• An environment variable GOLDRUSH_API_KEY containing a valid Golden Rush API key.

Installation Steps

First, clone the repository:

git clone https://github.com/covalenthq/goldrush-mcp-server.git
cd goldrush-mcp-server
npm install

Then, build the project:

npm run build

💻 Usage Examples

Starting the MCP Server

# Start the server (run dist/index.js)
npm run start

This will start the MCP server, which is usually connected by an MCP client.

Example Client

You can run the example client, which starts the server as a child process via STDIO:

npm run example

This example attempts to make several Covalent calls and prints the responses.

Running Tests

npm run test

This will run the entire test suite, covering the functionality of each service.

Setting GOLDRUSH_API_KEY

You must set the environment variable GOLDRUSH_API_KEY to a valid Golden Rush API key. For example, on Linux/macOS:

export GOLDRUSH_API_KEY=YOUR_KEY_HERE

On Windows:

set GOLDRUSH_API_KEY=YOUR_KEY_HERE

📚 Documentation

File Layout

goldrush-mcp-server
├── src
│   ├── index.ts                 # Main entry point of the MCP server
│   ├── services/                # Modular service implementations
│   │   ├── AllChainsService.ts  # Cross - chain tools
│   │   ├── BalanceService.ts    # Tools for handling balance - related requests
│   │   ├── BaseService.ts       # Basic blockchain tools
│   │   ├── BitcoinService.ts    # Bitcoin - specific tools
│   │   ├── NftService.ts        # NFT - related tools
│   │   ├── PricingService.ts    # Tools for handling pricing - related requests
│   │   ├── SecurityService.ts   # Security - related tools
│   │   └── TransactionService.ts# Tools for handling transaction - related requests
│   ├── resources/               # Resource implementations
│   │   ├── staticResources.ts   # Static configuration resources
│   │   └── dynamicResources.ts  # Dynamic chain state resources
│   ├── utils/                   # Utility functions and constants
│   │   ├── constants.ts         # Shared constants
│   │   └── helpers.ts           # Helper functions
│   └── example-client.ts        # Example LLM client using STDIO transport
├── test
│   ├── AllChainsService.test.ts
│   ├── BalanceService.test.ts
│   ├── BaseService.test.ts
│   ├── BitcoinService.test.ts
│   ├── NftService.test.ts
│   ├── PricingService.test.ts
│   ├── Resources.test.ts
│   ├── SecurityService.test.ts
│   └── TransactionService.test.ts
├── eslint.config.mjs            # ESLint configuration
├── package.json                 # Project dependencies and scripts
├── package-lock.json            # Dependency management lock file
├── README.md                    # Project documentation
└── dist/                        # Build output directory

Contribution Guidelines

• Reporting Issues: Please submit issues in the GitHub repository.
• Code Contributions: Please fork the repository and submit a pull request.

Additional Information

The Golden Rush MCP Server is an open - source project aimed at supporting blockchain data analysis. For more detailed information, please visit the GitHub repository.