Forge (Ethereum Smart Contract Development) MCP server

The MCP-Forge project provides a model context protocol interface for Foundry, allowing agents to pass in a Forge script to compile and simulate it. This implementation bridges the gap between AI agents and Foundry's smart contract development environment.

Installation

To install the MCP-Forge server, follow these steps:

1. Clone the repository:

   git clone https://github.com/username/mcp-forge.git
   cd mcp-forge
   

2. Install dependencies:

   # If using npm
   npm install
   
   # If using yarn
   yarn install
   

3. Configure your environment:

   # Create a .env file with your Foundry configuration
   cp .env.example .env
   

Usage

Basic Server Startup

To start the MCP server, run:

npm start
# or
yarn start

The server will start listening for incoming requests on the default port (typically 3000).

Sending Scripts for Compilation

You can send a Forge script to the server for compilation using a POST request:

curl -X POST http://localhost:3000/compile \
  -H "Content-Type: application/json" \
  -d '{"script": "// Your Forge script code here"}'

Simulating Scripts

To simulate a script, send a POST request to the simulation endpoint:

curl -X POST http://localhost:3000/simulate \
  -H "Content-Type: application/json" \
  -d '{
    "script": "// Your Forge script code here",
    "parameters": {
      "param1": "value1",
      "param2": "value2"
    }
  }'

Configuration Options

The server can be configured using environment variables or a configuration file:

• PORT: Set the server port (default: 3000)
• FOUNDRY_PATH: Path to your Foundry installation
• LOG_LEVEL: Set logging verbosity (default: "info")

Example configuration in .env file:

PORT=8080
FOUNDRY_PATH=/usr/local/bin/foundry
LOG_LEVEL=debug

API Endpoints

The server exposes several endpoints:

• POST /compile: Compiles a Forge script
• POST /simulate: Simulates a Forge script with provided parameters
• GET /status: Returns the current server status

Each endpoint returns JSON responses with appropriate status codes indicating success or failure.

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "mcp-forge" '{"command":"npx","args":["-y","mcp-forge"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "mcp-forge": {
            "command": "npx",
            "args": [
                "-y",
                "mcp-forge"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "mcp-forge": {
            "command": "npx",
            "args": [
                "-y",
                "mcp-forge"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect