Setup Guide 🛠️

Prerequisites 📝

  • Node.js v20.x or higher

  • npm or yarn

  • Git

  • Alchemy API Key (sign up at https://www.alchemy.com/)

  • Arbiscan API Key (sign up at https://arbiscan.io). This is optional but recommended for the decodeTransactionCalldata tool which uses it to fetch contract ABIs.

Installation 🧑‍💻

  1. Clone the repository:

git clone https://github.com/utkucy/arbitrum-mcp-tools.git
cd arbitrum-mcp-tools

  1. Create a .env file in the cloned project root with your API keys and configuration:

ALCHEMY_API_KEY=your_alchemy_api_key_here
ARBISCAN_API_KEY=your_arbiscan_api_key_here

# Stylus Contract Authentication (choose one method)
# Option 1: Direct private key (least secure, not recommended for production)
STYLUS_PRIVATE_KEY=your_private_key_here

# Option 2: Path to private key file (more secure)
STYLUS_PRIVATE_KEY_PATH=/path/to/your/private/key/file

# Option 3: Path to keystore file (most secure, requires password prompt)
STYLUS_KEYSTORE_PATH=/path/to/your/keystore/file

  1. Run one of the setup scripts in the arbitrum-mcp-tools directory as described in the sections below. These scripts will automatically install dependencies and build the project

Setup for Cursor 🖱️

  1. Run the setup script:

  1. When prompted, choose your installation method:

    • Option 1: Setup Locally (use current project files)

    • Option 2: Setup from NPM (install globally)

  2. The script will configure Cursor to use the Arbitrum MCP tools.

  3. Restart Cursor to apply the changes.

Setup for Claude 🤖

  1. Install Claude desktop application if you haven't already.

  2. Run the setup script:

  1. When prompted, choose your installation method:

    • Option 1: Setup Locally (It is recommended if you prefer to customize the tools and load them to LLMs.)

    • Option 2: Setup from NPM (install globally, recommended for general use.)

  2. The script will configure Claude to use the Arbitrum MCP tools and additional servers for terminal and file system access.

  3. Restart Claude to apply the changes.

Setup for Windsurf 🌊🪁

  1. Install Windsurf application if you haven't already.

  2. Run the setup script:

  1. When prompted, choose your installation method:

    • Option 1: Setup Locally (use current project files)

    • Option 2: Setup from NPM (install globally)

  2. The script will configure Windsurf to use the Arbitrum MCP tools.

  3. Restart Windsurf to apply the changes

Setup for Gemini CLI 💫

  1. Install the Gemini CLI if you haven't already.

  2. Run the setup script:

  1. When prompted, choose your installation method:

    • Option 1: Setup Locally (recommended if you plan to customize the tools)

    • Option 2: Setup from NPM (install globally, recommended for general use)

  2. The script will configure Gemini to use the Arbitrum MCP tools and will also install additional servers for desktop control and file-system access.

  3. Restart Gemini to apply the changes.

Note: The setup scripts will automatically use the Alchemy API key from your .env file to configure the MCP tools.

Usage

Once set up, the Arbitrum MCP tools will be available to your AI assistant. The tools are categorized by functionality and can be accessed through natural language.

PreviousOverviewNextProject Structure

Last updated