You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+48-9Lines changed: 48 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
A simple, lightweight and fast MCP (Model Context Protocol) server that provides Solidity development capabilities using the Foundry toolchain (Forge, Cast, and Anvil).
4
4
5
+

6
+
5
7
## Overview
6
8
7
9
This server connects LLM assistants to the Foundry ecosystem, enabling them to:
@@ -54,10 +56,10 @@ The server is designed to be used as an MCP tool provider for MCP Clients. When
1. Ensure Foundry tools (Forge, Cast, Anvil) are installed on your system:
63
65
```
@@ -67,10 +69,10 @@ The server is designed to be used as an MCP tool provider for MCP Clients. When
67
69
2. Clone and build the server.
68
70
69
71
```sh
70
-
bun build
72
+
bun i && bun build
71
73
```
72
74
73
-
3. Update your client config:
75
+
3. Update your client config (eg: Claude desktop):
74
76
75
77
```json
76
78
"mcpServers": {
@@ -86,6 +88,9 @@ The server is designed to be used as an MCP tool provider for MCP Clients. When
86
88
}
87
89
```
88
90
91
+
### Setup using NPM Package
92
+
- Coming soon
93
+
89
94
#### Configuration
90
95
91
96
The server supports the following environment variables:
@@ -99,13 +104,13 @@ The server maintains a persistent Forge workspace at `~/.mcp-foundry-workspace`
99
104
100
105
## Tools
101
106
102
-
### Anvil (Local EVM Node)
107
+
### Anvil
103
108
104
109
- `anvil_start`: Start a new Anvil instance
105
110
- `anvil_stop`: Stop a running Anvil instance
106
111
- `anvil_status`: Check if Anvil is running and get its status
107
112
108
-
### Cast (Onchain Operations)
113
+
### Cast
109
114
110
115
- `cast_call`: Call a contract function(read-only)
111
116
- `cast_send`: Send a transaction to a contract function
@@ -118,7 +123,7 @@ The server maintains a persistent Forge workspace at `~/.mcp-foundry-workspace`
118
123
- `cast_4byte`: Lookup functionor event signature from the 4byte directory
119
124
- `cast_chain`: Get information about the current chain
120
125
121
-
### Forge (Development Operations)
126
+
### Forge
122
127
123
128
- `forge_script`: Run a Forge script from the workspace
124
129
- `install_dependency`: Install a dependency for the Forge workspace
@@ -132,8 +137,42 @@ The server maintains a persistent Forge workspace at `~/.mcp-foundry-workspace`
132
137
### Utilities
133
138
134
139
- `convert_eth_units`: Convert between EVM units (wei, gwei, hex)
135
-
- `generate_wallet`: Generate a new EVM wallet
136
140
- `compute_address`: Compute the address of a contract that would be deployed
137
141
- `contract_size`: Get the bytecode size of a deployed contract
138
142
- `estimate_gas`: Estimate the gas cost of a transaction
139
143
144
+
## Usage in Claude Desktop App 🎯
145
+
146
+
Once the installation is complete, and the Claude desktop app is configured, you must completely close and re-open the Claude desktop app to see the tavily-mcp server. You should see a hammer icon in the bottom left of the app, indicating available MCP tools, you can click on the hammer icon to see more details on the available tools.
147
+
148
+

149
+
150
+
Now claude will have complete access to the foundry-mcp server. If you insert the below examples into the Claude desktop app, you should see the foundry-mcp server tools in action.
151
+
152
+
### Examples
153
+
154
+
1. **Transaction analysis**:
155
+
```
156
+
Can you analyze the transaction and explain what it does?
0 commit comments