MCP Ethers Server

🚀 MCP Protocol Implementation

A powerful tool supporting ERC20, ERC721, and ERC1155 token standards, integrating wallet functions, token operations, and smart contract interactions to facilitate blockchain development.

🚀 Quick Start

Environment Variable Setup

Add the following content to the .env file in the root directory of your project:

ALCHEMY_API_KEY=your_alchemy_api_key
INFURA_PROJECT_ID=your_infura_project_id

Service Startup

Run the following command in the terminal to start the MCP server:

npm run start

📦 Network Configuration

Add your network configuration to the config/networks.json file, for example:

{
  "mainnet": {
    "name": "Ethereum Main Network",
    "chainId": 1,
    "providerType": "ALCHEMY"
  },
  "ropsten": {
    "name": "Ethereum Test Network - Ropsten",
    "chainId": 3,
    "providerType": "INFURA"
  }
}

✨ Features

Wallet Functions

• Wallet Creation: Generate a new Ethereum wallet address.
• Private Key Management: Support saving private keys to environment variables or memory.
• Balance Inquiry: Get the ETH and token balances of a specified address.

Token Operations

• ERC20: Implement basic token functions such as transfer and approval.
• ERC721: Support NFT minting, transfer, and ownership inquiry.
• ERC1155: Implement batch token operations, including single and multiple token transfers.

Smart Contract Interactions

• Method Call: Call smart contract methods through the ABI interface.
• Event Listening: Monitor blockchain events in real - time.
• Transaction Processing: Send and confirm transaction requests.

🔧 Technical Details

Caching Mechanism

The system enables caching for the following operations:

• Token information (name, symbol, decimal places)
• Token balances
• Contract method calls

By default, the cache is valid for 1 hour. You can customize the caching strategy in config/cache.json.

Rate Limiting

To prevent abuse and ensure system stability, the server enforces rate limits on the following operations:

• Write operations (transfer, authorization)
• Wallet generation
• Contract interactions

Error Handling

The system provides detailed error information and status codes for easy debugging and issue troubleshooting. All errors are securely handled to prevent sensitive data leakage.

💻 Usage Examples

Building the Project

Run the following command to build the project:

npm run build

Test Suite

Run All Tests Using Bun (Recommended)

# Start the Hardhat node in the terminal
npx hardhat node

# Run all test cases
bun test

Run Only MCP Client Tests

bun run test:client:mcp

📚 Documentation

Development Guide

The above sections cover the building and testing of the project. You can follow these steps to develop and test your MCP protocol implementation.

Security Precautions

• Private Key Management: By default, the wallet function does not save private keys to the file system. It is recommended to use the saveToEnv option with caution when handling sensitive operations.
• API Keys: Ensure the security of the .env file to avoid exposing API keys.

📄 License

The MCP protocol implementation is licensed under the MIT License, allowing free use, modification, and distribution.