mt5-quant/docs/QUICKSTART.md

Quickstart Guide

1. Download or Build

Option A: Prebuilt Binary (Recommended)

# macOS (Apple Silicon)
curl -L -o mt5-quant.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mt5-quant-macos-arm64.tar.gz
tar -xzf mt5-quant.tar.gz

# Linux (x64)
curl -L -o mt5-quant.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mt5-quant-linux-x64.tar.gz
tar -xzf mt5-quant.tar.gz

Option B: Build from Source

git clone https://github.com/masdevid/mt5-quant
cd mt5-quant
bash scripts/build-rust.sh

2. Install MetaTrader 5

macOS - MetaTrader 5.app (Free)

1. Download from metatrader5.com
2. Install to /Applications
3. Launch once to initialize Wine prefix (~30s), then quit

Auto-detected paths:

• Wine: /Applications/MetaTrader 5.app/Contents/SharedSupport/wine/bin/wine64
• MT5: ~/Library/Application Support/net.metaquotes.wine.metatrader5/drive_c/Program Files/MetaTrader 5

macOS - CrossOver (Paid, Better Compatibility)

1. Install CrossOver
2. Create bottle MetaTrader5
3. Install MT5 inside bottle

Auto-detected paths:

• Wine: /Applications/CrossOver.app/Contents/SharedSupport/CrossOver/bin/wine64
• MT5: ~/Library/Application Support/MetaQuotes/<hash>/drive_c/Program Files/MetaTrader 5

Linux

# Debian/Ubuntu
sudo apt install wine64 xvfb

# Fedora/RHEL
sudo dnf install wine xorg-x11-server-Xvfb

# Install MT5
wine64 MetaTrader5Setup.exe

MT5 location: ~/.wine/drive_c/Program Files/MetaTrader 5

3. Configure

Run the setup script to auto-detect paths:

bash scripts/setup.sh          # interactive
bash scripts/setup.sh --yes    # non-interactive (CI)

This creates config/mt5-quant.yaml (gitignored).

Minimum config:

wine_executable: "/Applications/MetaTrader 5.app/Contents/SharedSupport/wine/bin/wine64"
terminal_dir: "~/Library/Application Support/net.metaquotes.wine.metatrader5/drive_c/Program Files/MetaTrader 5"

4. Register MCP Server

Claude Code

claude mcp add io.github.masdevid/mt5-quant -- ~/.local/bin/mt5-quant

Verify:

claude mcp list

Windsurf

Add to ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "io.github.masdevid/mt5-quant": {
      "command": "~/.local/bin/mt5-quant",
      "disabled": false,
      "registry": "io.github.masdevid/mt5-quant"
    }
  }
}

Cursor

Add to ~/.cursor/mcp.json (global) or .cursor/mcp.json (project):

{
  "mcpServers": {
    "mt5-quant": {
      "command": "~/.local/bin/mt5-quant"
    }
  }
}

Or use Settings → MCP → Add Custom MCP.

VS Code

Add to .vscode/mcp.json in your workspace:

{
  "servers": {
    "mt5-quant": {
      "command": "/path/to/mt5-quant"
    }
  }
}

Or run MCP: Add Server from Command Palette.

Claude Desktop

1. Open Agent panel → Click "..." menu → MCP Servers
2. Click "Manage MCP Servers"
3. Click "View raw config" or "Edit configuration"
4. Add to mcp_config.json:

{
  "mcpServers": {
    "mt5-quant": {
      "command": "/path/to/mt5-quant"
    }
  }
}

5. Restart Claude Desktop to apply changes

5. Verify Setup

bash scripts/platform_detect.sh

Or in Claude/Windsurf:

Run verify_setup

Expected output:

Wine:    /Applications/MetaTrader 5.app/.../wine64
MT5 dir: ~/Library/Application Support/.../MetaTrader 5
Display: gui
Arch:    arch -x86_64

6. Run First Backtest

Run a backtest on MyEA from 2025.01.01 to 2025.03.31

The AI will:

1. Verify setup
2. Compile your EA
3. Clean MT5 cache
4. Run backtest
5. Extract and analyze results
6. Report key findings

---

Next: See TOOLS.md for all 89 available tools.