Etherscan MCP Server

🚀 Etherscan MCP Server

An Etherscan API client implemented in Go, specifically designed for the Model Context Protocol (MCP), enabling LLM applications to access Ethereum blockchain data.

🚀 Quick Start

Starting the Service

mcp-server start

Stopping the Service

mcp-server stop

Restarting the Service

mcp-server restart

✨ Features

• Access Etherscan API V2 for multi-chain support.
• Use a single API key to call over 50 supported chains.
• Support multiple ways to obtain blockchain data:
  • Query account balances.
  • Retrieve block information.
  • Get contract data (ABI, source code).
  • Access gas price oracle.
  • Obtain token information.
  • Fetch transaction data.
  • And many more features.

📦 Installation

Prerequisites

• An Etherscan API key (obtainable from https://etherscan.io/myapikey).

Steps

1. Clone the repository:

   git clone https://github.com/huahuayu/etherscan-mcp-server.git
   

2. Configure and install as follows:
   • Step 1: Download and install the Go environment if not already installed.
   • Step 2: Clone the above repository to your local development environment.
   • Step 3: Navigate to the repository directory in the terminal and run the following command to install:

     go install
     

   • Step 4: After installation, ensure that the executable file is added to the system PATH environment variable.
3. Installation completed!

💻 Usage Examples

Configuration File

By default, the server reads the configuration file located at $HOME/.etherscan-mcp/config.yaml. You can customize the following settings by editing this file:

• API Key: Specify your Etherscan API key.
• Listening Address: Define the IP address to which the server binds.
• Listening Port: Configure the port number on which the server runs.

Basic Usage

# Get account balance
mcp-server get-account-balance --address 0x1234567890abcdeF123456789abcdEF123456789 --chain-id 1

# Query block information
mcp-server get-block-by-number --chain-id 1 --block-number 1000000

# Get token balance
mcp-server get-token-balance --address 0x1234567890abcdeF123456789abcdEF123456789 --chain-id 1 --contract-address 0xEeeeeEeeeEeC9c7B2CBb6bb42C975a9769e0Eed0af

Tool List

The Etherscan MCP server provides the following tools for accessing blockchain data:

1. getAccountBalance - Get the balance information of a specific account on a specified chain.
2. getBlockByNumber - Query block details based on the block number.
3. getBlockRewards - Get the reward information of a specified block.
4. getContractABI - Get the ABI interface of a verified contract.
5. getContractSourceCode - Get the source code of a verified contract.
6. executeContractMethod - Execute read-only contract functions.
7. getGasOracle - Get the current gas price oracle output data.
8. getTokenBalance - Get the token balance information of a specified account on a specific chain.
9. getTokenDetails - Get detailed token information.
10. getTransactionByHash - Get transaction details based on the transaction hash.
11. getTransactionByBlockNumberAndIndex - Get transaction details based on the block number and index.
12. getTransactionCount - Get the total number of transactions sent by a specified address.
13. getTransactionReceipt - View the transaction receipt status.
14. getTransactionStatus - Query the contract execution status.
15. getTransactionsByAddress - Get a list of transactions based on an address.
16. getInternalTransactionsByAddress - Get a list of internal transactions based on an address.
17. getTokenTransfersByAddress - Get token transfer records based on an address.
18. getERC721Transfers - Get transfer records of ERC721 tokens based on an address.
19. getLatestBlockNumber - Get the latest block number.

Each tool accepts specific parameters and returns structured blockchain data.

📄 License

MIT