Web3 MCP

1# Web3 MCP
2 
3[![Tests](https://github.com/tumf/web3-mcp/actions/workflows/test.yml/badge.svg)](https://github.com/tumf/web3-mcp/actions/workflows/test.yml)
4[![codecov](https://codecov.io/gh/tumf/web3-mcp/branch/main/graph/badge.svg)](https://codecov.io/gh/tumf/web3-mcp)
5[![PyPI version](https://badge.fury.io/py/web3-mcp.svg)](https://badge.fury.io/py/web3-mcp)
6[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7 
8An MCP server implementation wrapping Ankr Advanced API.
9 
10## Overview
11 
12FastMCP is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server that provides access to Ankr's Advanced API for blockchain data. It allows LLMs to interact with blockchain data across multiple chains including Ethereum, BSC, Polygon, Avalanche, and more.
13 
14## MCP Client Setting
15 
16```json
17{
18  "mcpServers": {
19    "web3": {
20      "command": "uvx",
21      "args": [
22        "web3-mcp"
23      ],
24      "env": {
25        "ANKR_ENDPOINT": "https://rpc.ankr.com/...",
26      }
27    }
28  }
29}
30```
31 
32## Features
33 
34- Complete wrapper for all Ankr Advanced API endpoints
35- NFT API: Get NFT metadata, holders, transfers, and ownership information
36- Query API: Access blockchain statistics, blocks, logs, and transaction data
37- Token API: Get token balances, prices, holders, and transfer history
38- Support for multiple blockchain networks
39 
40## Installation
41 
42```bash
43# Clone the repository
44git clone https://github.com/tumf/web3-mcp.git
45cd web3-mcp
46 
47# Install with uv
48uv pip install -e .
49```
50 
51## Configuration
52 
53Set the following environment variables:
54 
55```bash
56# Required
57export ANKR_ENDPOINT="your_ankr_rpc_endpoint"
58 
59# Optional but recommended for authenticated requests
60export ANKR_PRIVATE_KEY="your_private_key"
61```
62 
63## Usage
64 
65### Running the server
66 
67```python
68from web3_mcp.server import init_server
69 
70# Initialize MCP server
71mcp = init_server(
72    name="Ankr MCP",
73    endpoint="your_ankr_endpoint",  # Optional, defaults to ANKR_ENDPOINT env var
74    private_key="your_private_key"  # Optional, defaults to ANKR_PRIVATE_KEY env var
75)
76 
77# Run server
78mcp.run()
79```
80 
81### Using with FastMCP CLI
82 
83```bash
84# Set environment variables first
85export ANKR_ENDPOINT="your_ankr_endpoint"
86export ANKR_PRIVATE_KEY="your_private_key"
87 
88# Run the server
89python -m web3_mcp
90```
91 
92## API Categories
93 
94### NFT API
95 
96- `get_nfts_by_owner`: Get NFTs owned by a wallet address
97- `get_nft_metadata`: Get metadata for a specific NFT
98- `get_nft_holders`: Get holders of a specific NFT collection
99- `get_nft_transfers`: Get transfer history for NFTs
100 
101### Query API
102 
103- `get_blockchain_stats`: Get blockchain statistics
104- `get_blocks`: Get blocks information
105- `get_logs`: Get blockchain logs
106- `get_transactions_by_hash`: Get transactions by hash
107- `get_transactions_by_address`: Get transactions by address
108- `get_interactions`: Get wallet interactions with contracts
109 
110### Token API
111 
112- `get_account_balance`: Get token balances for a wallet
113- `get_currencies`: Get available currencies
114- `get_token_price`: Get token price information
115- `get_token_holders`: Get token holders
116- `get_token_holders_count`: Get token holders count
117- `get_token_transfers`: Get token transfer history
118 
119## License
120 
121MIT
122