Skip to content

Commit 3f31189

Browse files
committed
docs: 📝 readme
1 parent 839fc09 commit 3f31189

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,10 @@ The server is designed to be used as an MCP tool provider for MCP Clients. When
8888
}
8989
```
9090

91+
> [!NOTE]
92+
> `PRIVATE_KEY` is optional
93+
94+
9195
### Setup using NPM Package
9296
- Coming soon
9397

@@ -98,6 +102,10 @@ The server supports the following environment variables:
98102
- `RPC_URL`: Default RPC URL to use when none is specified (optional)
99103
- `PRIVATE_KEY`: Private key to use for transactions (optional)
100104

105+
> [!CAUTION]
106+
> Do not add keys with mainnet funds. Even though the code uses it safely, LLMs can hallicunate and send malicious transactions.
107+
> Use it only for testing/development purposes. DO NOT trust the LLM!!
108+
101109
### Workspace
102110

103111
The server maintains a persistent Forge workspace at `~/.mcp-foundry-workspace` for all Solidity files, scripts, and dependencies.
@@ -175,4 +183,8 @@ Deploy a mock ERC20 contract to a local mainnet forked anvil instance with block
175183
## Acknowledgments ✨
176184

177185
- [Model Context Protocol](https://modelcontextprotocol.io) for the MCP specification
178-
- [Anthropic](https://anthropic.com) for Claude Desktop
186+
- [Anthropic](https://anthropic.com) for Claude Desktop
187+
188+
## Disclaimer
189+
190+
_The software is being provided as is. No guarantee, representation or warranty is being made, express or implied, as to the safety or correctness of the software. They have not been audited and as such there can be no assurance they will work as intended, and users may experience delays, failures, errors, omissions, loss of transmitted information or loss of funds. The creators are not liable for any of the foregoing. Users should proceed with caution and use at their own risk._

0 commit comments

Comments
 (0)