web3-tools-mcp 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +67 -26
- package/dist/index.js +0 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,37 +1,48 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Web3 Tools MCP Server
|
|
2
2
|
|
|
3
|
-
A Model Context Protocol (MCP) server that provides comprehensive blockchain interaction capabilities using
|
|
3
|
+
A Model Context Protocol (MCP) server that provides comprehensive blockchain interaction capabilities using [viem](https://viem.sh/), [Etherscan APIs](https://etherscan.io), and [Hypersync](https://docs.envio.dev/docs/HyperSync/overview). This server enables AI assistants to interact with multiple blockchain networks, query contract data, analyze transactions, and work with smart contracts with enhanced performance and reliability.
|
|
4
4
|
|
|
5
|
-
## 📦 Installation
|
|
5
|
+
## 📦 Installation & Setup
|
|
6
6
|
|
|
7
|
-
###
|
|
8
|
-
|
|
9
|
-
npm install -g web3-tools-mcp
|
|
10
|
-
```
|
|
7
|
+
### Quick Start (Recommended)
|
|
8
|
+
The easiest way to use this MCP server is with `npx` - no installation required! Add it directly to your MCP client configuration.
|
|
11
9
|
|
|
12
|
-
###
|
|
13
|
-
|
|
14
|
-
```bash
|
|
15
|
-
web3-tools-mcp
|
|
16
|
-
```
|
|
10
|
+
### MCP Client Configuration
|
|
11
|
+
Add to your MCP client configuration (e.g., Claude Desktop `config.json`):
|
|
17
12
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
13
|
+
```json
|
|
14
|
+
{
|
|
15
|
+
"mcp": {
|
|
16
|
+
"servers": {
|
|
17
|
+
"web3-tools": {
|
|
18
|
+
"command": "npx",
|
|
19
|
+
"args": [
|
|
20
|
+
"-y",
|
|
21
|
+
"web3-tools-mcp",
|
|
22
|
+
"--etherscan-api-key",
|
|
23
|
+
"YOUR_ETHERSCAN_API_KEY",
|
|
24
|
+
"--hypersync-api-key",
|
|
25
|
+
"YOUR_HYPERSYNC_API_KEY"
|
|
26
|
+
]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
}
|
|
21
31
|
```
|
|
22
32
|
|
|
23
|
-
|
|
24
|
-
|
|
33
|
+
**Why npx?**
|
|
34
|
+
- ✅ No global installation required
|
|
35
|
+
- ✅ Always uses the latest version
|
|
36
|
+
- ✅ Automatic dependency management
|
|
37
|
+
- ✅ Works across different environments
|
|
38
|
+
|
|
39
|
+
### Alternative: Global Installation
|
|
40
|
+
If you prefer to install globally:
|
|
25
41
|
```bash
|
|
26
|
-
|
|
27
|
-
export ALCHEMY_API_KEY=your_key_here
|
|
28
|
-
export INFURA_API_KEY=your_key_here
|
|
29
|
-
export HYPERSYNC_API_KEY=your_key_here
|
|
30
|
-
web3-tools-mcp
|
|
42
|
+
npm install -g web3-tools-mcp
|
|
31
43
|
```
|
|
32
44
|
|
|
33
|
-
|
|
34
|
-
Add to your MCP client configuration (e.g., Claude Desktop):
|
|
45
|
+
Then use in your MCP config:
|
|
35
46
|
```json
|
|
36
47
|
{
|
|
37
48
|
"mcp": {
|
|
@@ -39,8 +50,8 @@ Add to your MCP client configuration (e.g., Claude Desktop):
|
|
|
39
50
|
"web3-tools": {
|
|
40
51
|
"command": "web3-tools-mcp",
|
|
41
52
|
"args": [
|
|
42
|
-
"--etherscan-api-key", "
|
|
43
|
-
"--
|
|
53
|
+
"--etherscan-api-key", "YOUR_ETHERSCAN_API_KEY",
|
|
54
|
+
"--hypersync-api-key", "YOUR_HYPERSYNC_API_KEY"
|
|
44
55
|
]
|
|
45
56
|
}
|
|
46
57
|
}
|
|
@@ -48,6 +59,36 @@ Add to your MCP client configuration (e.g., Claude Desktop):
|
|
|
48
59
|
}
|
|
49
60
|
```
|
|
50
61
|
|
|
62
|
+
### Command Line Usage
|
|
63
|
+
You can also run the server directly:
|
|
64
|
+
```bash
|
|
65
|
+
# Using npx (recommended)
|
|
66
|
+
npx web3-tools-mcp --etherscan-api-key YOUR_KEY --hypersync-api-key YOUR_KEY
|
|
67
|
+
|
|
68
|
+
# Or if globally installed
|
|
69
|
+
web3-tools-mcp --etherscan-api-key YOUR_KEY --hypersync-api-key YOUR_KEY
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Environment Variables
|
|
73
|
+
Alternative to command line arguments:
|
|
74
|
+
```bash
|
|
75
|
+
export ETHERSCAN_API_KEY=your_etherscan_key_here
|
|
76
|
+
export HYPERSYNC_API_KEY=your_hypersync_key_here
|
|
77
|
+
export ALCHEMY_API_KEY=your_alchemy_key_here # optional
|
|
78
|
+
export INFURA_API_KEY=your_infura_key_here # optional
|
|
79
|
+
npx web3-tools-mcp
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### API Keys
|
|
83
|
+
- **Etherscan API Key**: Required for contract ABI fetching and verification status
|
|
84
|
+
- Get free API key at [etherscan.io/apis](https://etherscan.io/apis)
|
|
85
|
+
- **Hypersync API Key**: Required for fast event log querying
|
|
86
|
+
- Get free API key at [hypersync.xyz](https://hypersync.xyz)
|
|
87
|
+
- **Alchemy API Key**: Optional, provides enhanced RPC reliability
|
|
88
|
+
- Get free API key at [alchemy.com](https://alchemy.com)
|
|
89
|
+
- **Infura API Key**: Optional, additional RPC provider for failover
|
|
90
|
+
- Get free API key at [infura.io](https://infura.io)
|
|
91
|
+
|
|
51
92
|
## 🌟 Key Features
|
|
52
93
|
|
|
53
94
|
- **Multi-chain Support**: Works with Ethereum mainnet, Base, Arbitrum, Polygon, Optimism, Celo, and localhost
|
package/dist/index.js
CHANGED
|
@@ -28276,9 +28276,7 @@ class ViemMCPServer {
|
|
|
28276
28276
|
async run() {
|
|
28277
28277
|
const transport = new StdioServerTransport;
|
|
28278
28278
|
await this.server.connect(transport);
|
|
28279
|
-
console.log("Viem MCP server running on stdio");
|
|
28280
28279
|
}
|
|
28281
28280
|
}
|
|
28282
|
-
console.log("Starting Viem MCP server...");
|
|
28283
28281
|
var server = new ViemMCPServer(config);
|
|
28284
28282
|
server.run().catch(console.error);
|