Foundry MCP

🚀 Foundry MCP Project

This project is a Model Context Protocol (MCP) server designed to interact with Foundry tools. It offers a set of tools and utilities for managing Foundry projects, running tests, building contracts, and more.

📂 Project Structure

pyproject.toml       # Project configuration file
README.md            # Project documentation
uv.lock              # Dependency lock file
LLM/                 # Documentation and SDK usage instructions
src/eth_wh_mcp/      # Source code of the MCP server

✨ Features

• Create Foundry Project: Initialize a new Foundry project.
• Build Contracts: Compile Solidity contracts with various options.
• Run Tests: Execute tests for Foundry projects with detailed configurations.
• Inspect Contracts: Retrieve ABI, bytecode, and other metadata.
• Run Scripts: Execute Solidity scripts.
• Start Local Node: Launch a local Ethereum node using Anvil or Chisel.
• Advanced Cast Commands: Execute Ethereum-related commands using cast.

📦 Installation

1. Clone the repository:

   git clone <repository-url>
   

2. Ensure that Foundry tools (forge, cast, anvil, etc.) are installed and added to the PATH.

💻 Usage Examples

Basic Usage

To start the MCP server:

python src/eth_wh_mcp/main.py

Available Tools

The MCP server provides the following tools:

• create_project: Initialize a new Foundry project.
• build_project: Build the current Foundry project.
• test_project: Run tests for the Foundry project.
• clone_contract: Clone a contract from Etherscan.
• run_script: Execute a Solidity script.
• run_cast_command: Run a cast command.
• start_anvil_with_options: Start an Anvil local Ethereum node with options.
• start_chisel_with_options: Start a Chisel Solidity REPL with options.
• inspect_contract: Inspect contract metadata.
• snapshot_project: Create a gas usage snapshot.
• coverage_project: Display test coverage.

📚 Documentation

MCP Python SDK

Refer to the LLM/python-mcp-sdk.md file for detailed instructions on using the MCP Python SDK, including server construction, tool usage, prompts, and context handling.

🔧 Technical Details

Local Debugging

Run the MCP server in development mode:

mcp dev src/eth_wh_mcp/main.py --with-editable .

Runtime Execution

To execute the server:

python src/eth_wh_mcp/main.py

📄 License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file.