Evm MCP Server

🚀 Ethereum Virtual Machine (EVM) MCP Server Documentation

This documentation provides a comprehensive guide to the Ethereum Virtual Machine (EVM) MCP server, including installation, configuration, core architecture, technical specifications, and security considerations.

🚀 Quick Start

Installation and Running

Installation

1. Clone the repository:

git clone git@github.com:your-repository.git mcp-evm-server
cd mcp-evm-server
npm install

2. Start the server:

npm run dev

3. Access the console: After startup, access http://localhost:5000 using a browser or the curl command in the terminal.

Configuration

Edit the src/server/http-server.ts file to adjust the following configurations:

• PORT: Server port, default is 5000
• NETWORKS: Supported blockchain networks, such as Ethereum, Polygon, etc.
• RPC_ENDPOINTS: URLs of third - party RPC providers
• WALLET_PROVIDERS: Configuration of wallet providers

✨ Features

Core Components

1. HTTP Server
   • Provides real - time updates using Server - Sent Events (SSE)
   • Supports RESTful API and long polling
2. Blockchain Service
   • Handles blockchain operations related to EVM
3. Resource System
   • Exposes blockchain data resource URIs, such as chain information, blocks, transactions, etc.
4. Toolkit
   • Provides blockchain analysis and interaction tools

Core Functional Features

• Supports multiple blockchain networks
• Built - in wallet and transaction services
• Real - time blockchain event listening
• Read and write operations on smart contracts
• Token balance query and transfer
• Support for NFT and ERC1155 tokens

📚 Documentation

Network Configuration

type NetworkConfig = {
  chainId: number;
  name: string;
  rpcUrls: string[];
  blockExplorers?: Record<string, string>;
};

Accounts and Transactions

• Supports multiple wallet providers (e.g., MetaMask, WalletConnect)
• Signs and broadcasts transactions
• Parses transaction receipts

🔧 Technical Details

Security Considerations

• Private Key Security: Only used for transaction signing, not stored on the server.
• Authentication: It is recommended to add additional authentication mechanisms in the production environment.
• Transport Encryption: Use HTTPS for production environment deployment.
• Rate Limiting: Prevent abuse attacks.
• High - value Services: Add confirmation steps.

Project Structure

mcp-evm-server/
├── src/
│   ├── index.ts                # Entry file for standard input and output server
│   ├── server/                 # Server - related files
│   │   ├── http-server.ts      # HTTP server implementation with SSE support
│   │   └── server.ts           # General server settings
│   ├── core/
│   │   ├── chains.ts           # Blockchain chain definition and tools
│   │   ├── resources.ts        # MCP resource implementation
│   │   ├── tools.ts            # MCP tool implementation
│   │   ├── prompts.ts          # MCP prompt implementation
│   │   └── services/           # Core blockchain services
│   │       ├── index.ts        # Operation exports
│   │       ├── network.ts      # Network configuration and management
│   │       ├── wallet.ts       # Wallet function implementation
│   │       ├── transaction.ts  # Transaction processing logic
│   │       └── contract.ts     # Smart contract interaction
├── package.json                # Project dependencies and scripts
└── README.md                   # Project documentation

Development Guide

1. Development Environment
   • Use Node.js and TypeScript.
   • Install pnpm or npm for dependency management.
2. Debugging Tips
   • Start the development server: npm run dev
   • Runtime directory: src/
3. Build and Deployment
   • Production build: npm run build
   • Deploy to cloud services (e.g., AWS, Azure)
4. Contribution Guide
   • Ensure unit tests pass before submitting code.
   • Follow the code style guidelines.

📄 License

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

Appendix

Frequently Asked Questions

1. How to add a new blockchain network?
   • Add the corresponding configuration in chains.ts.
2. Which wallet providers are supported?
   • Currently supports mainstream providers such as MetaMask and WalletConnect.
3. How to handle transaction failures?
   • Capture and retry through the error handling module.

Contact Information

• Email: contact@example.com
• GitHub: github.com/your - repository

Thank you for using the Ethereum Virtual Machine (EVM) MCP server! For more help, please refer to the documentation or contact the support team.