Metamask MCP

🚀 MetaMask MCP Server

A Model Context Protocol (MCP) server that allows Large Language Models (LLMs) to interact with the blockchain through MetaMask. With these tools, your private keys will be securely stored in your crypto wallet and will never be shared with AI agents when signing messages or sending transactions.

🚀 Quick Start

Preview

https://github.com/user-attachments/assets/3fe8f20b-4666-4c36-8030-04d3e5d587c7

Requirements

• Node.js (v20 or higher)
• pnpm

📦 Installation

1. Clone the repository

git clone https://github.com/Xiawpohr/metamask-mcp.git
cd metamask-mcp

2. Install dependencies

pnpm install

3. Build the project

pnpm build

💻 Usage Examples

Basic Usage

To use it with Claude Desktop, please refer to the guide at https://modelcontextprotocol.io/quickstart/user and add the following configuration:

{
  "mcpServers": {
    "metamask": {
      "command": "node",
      "args": [
        "/actual/path/TO/YOUR_PROJECT/dist/index.ts"
      ]
    }
  }
}

Toolset

• call: Execute a new message call immediately, but do not submit the transaction to the network.
• get-chain-list: Get a list of information for all chains.
• get-connect-uri: Get the connection URI to connect to the MetaMask wallet.
• show-connect-qrcode: Display the connection QR code for a given connection URI.
• deploy-contract: Deploy a contract on the blockchain based on bytecode and constructor parameters.
• disconnect: Disconnect the wallet.
• estimate-fee-per-gas: Estimate the fee (in wei) required for the next transaction to be included in the network.
• estimate-gas: Estimate the amount of gas required to complete a transaction without submitting it to the network.
• get-account: Get current account information.
• get-native-currency-balance: Get the native currency balance of an address.
• get-token-balance: Get the token balance of an address.
• get-block-number: Get the number of the latest block.
• get-block: Get block information based on number, hash, or tag.
• get-chain-id: Get the current chain ID.
• get-chains: Get information about all configured chains.
• get-ens-address: Get the ENS address corresponding to a name.
• get-ens-name: Get the primary ENS name of an address.
• get-gas-price: Get the current gas price (in wei).
• get-token: Get token information.
• get-transaction-reeceipt: Get the transaction receipt based on the transaction hash.
• get-transaction: Get transaction information based on hash or block identifier.
• read-contract: Call a read-only function of a contract and return the response.
• send-transaction: Send a transaction to the network.
• sign-message: Sign message content.
• switch-chain: Switch the target chain.
• verify-message: Verify whether a message is signed by a specific address.
• write-contract: Call a write function of a contract and perform state-changing operations.

Tips

• The Prompts section mentions a specific prompt file. Please refer to the file for detailed information.

Contribution Guidelines

We welcome community members to contribute to this project. Please refer to the project's contribution guidelines to learn how to participate in the development.

📄 License

This project is licensed under the MIT License. Please check the project's LICENSE file for specific terms.