Getting Started¶

Welcome to UCAI! This section will guide you through installation, your first server generation, and understanding what gets created.

Overview¶

UCAI is a command-line tool (abi-to-mcp) and Python library that transforms Ethereum smart contract ABIs into fully functional MCP (Model Context Protocol) servers. These servers enable AI assistants like Claude to interact with any smart contract through a standardized interface.

What You'll Learn¶

Installation

Set up abi-to-mcp on your system with pip, pipx, or from source.

Installation guide
Quickstart

Generate your first MCP server in under 5 minutes.

Quickstart
First MCP Server

Deep dive into the generated server structure and how it works.

Understanding the output

Prerequisites¶

Before you begin, ensure you have:

Python 3.10 or higher - Check with python --version
pip - Python package installer (comes with Python)
Internet access - For fetching ABIs from block explorers

Optional but Recommended¶

Etherscan API key - For higher rate limits when fetching ABIs
RPC endpoint - For connecting to blockchain networks (free options available)
Claude Desktop - For using generated servers with Claude

Quick Path¶

If you're eager to get started, here's the fastest path:

# 1. Install
pip install abi-to-mcp

# 2. Generate (using USDC as an example)
abi-to-mcp generate 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 -n mainnet -o ./usdc-mcp

# 3. Configure
cd usdc-mcp
cp .env.example .env
# Edit .env to add your RPC_URL

# 4. Run
pip install -r requirements.txt
python server.py

For detailed explanations, continue to the Installation page.

Examples Available

Check out the examples/ folder for ready-to-use example configurations for ERC20 tokens, NFT collections, DeFi protocols, and Claude Desktop integration.

Getting Help¶

If you run into issues:

Check the Errors Reference for common problems
Search GitHub Issues
Open a new issue with details about your problem

Next Steps¶

Start with Installation to set up abi-to-mcp on your system.