feat: add list_symbols and list_experts MCP tools; fix symbol check
list_symbols: - Reads terminal.ini to detect active broker server (LastScanServer) - Lists all servers in Bases/ with their available symbols - Warns if OptMode=-1 needs reset - Accepts optional server filter list_experts: - Recursively scans MQL5/Experts/ including sub-folders - Returns name, subfolder, and ready-to-use run_backtest_expert value - Accepts optional name filter (case-insensitive) backtest_pipeline.sh: - Fail fast with clear actionable message when MT5 is running and --kill-existing not set (instead of silently timing out after 900s) - Updated help text for --kill-existing flag _check_symbol fix: - Was reading terminal_dir/history/ (does not exist) - Now reads Bases/<active_server>/history/ from terminal.ini - When symbol missing: shows which other servers have it Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Devid HW
@@ -23,7 +23,9 @@
|
||||
# --strategy NAME Analysis strategy profile: grid (default) | scalper | trend | hedge | generic
|
||||
# --timeout N Backtest timeout in seconds (default: 900)
|
||||
# --shutdown Close MT5 after backtest (default: keep open). Use for CI/headless.
|
||||
# --kill-existing Kill a running MT5 instance before launching (default: pass config to it)
|
||||
# --kill-existing Kill running MT5 before launching. Required when MT5 is open.
|
||||
# With default mode (no --shutdown): MT5 restarts, runs backtest,
|
||||
# then stays open so you can inspect results in the GUI.
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
@@ -374,17 +376,30 @@ BATEOF
|
||||
MT5_REPORT=$(find "${MT5_DIR}" -maxdepth 3 -name "*.htm" -newer "${INI_HOST_PATH}" 2>/dev/null | head -1)
|
||||
else
|
||||
# ── Background mode (default) ──────────────────────────────────────────────
|
||||
# MT5 is a single-instance Windows app: if already running, launching a
|
||||
# second instance passes the /config: args to the existing window and exits.
|
||||
# This triggers the Strategy Tester in the running MT5 without closing it.
|
||||
# If MT5 is not running, it starts fresh. Either way, ShutdownTerminal=0
|
||||
# keeps it alive; we detect completion by watching for the report file.
|
||||
# MT5 uses a single-instance lock per Wine prefix. On Wine/CrossOver, a second
|
||||
# terminal64.exe instance exits immediately without forwarding the config to
|
||||
# the running instance (unlike native Windows behaviour).
|
||||
# When MT5 is running, we must kill it first — but with ShutdownTerminal=0
|
||||
# the new instance stays open after the backtest, so the user can inspect
|
||||
# results in the GUI without a permanent disruption.
|
||||
if $MT5_WAS_RUNNING; then
|
||||
echo " MT5 is running — passing config to existing instance..."
|
||||
else
|
||||
echo " Launching MT5 in background (ShutdownTerminal=0)..."
|
||||
echo "" >&2
|
||||
echo " ERROR: MetaTrader 5 is already running." >&2
|
||||
echo "" >&2
|
||||
echo " On Wine/CrossOver a second MT5 instance cannot pass a backtest config" >&2
|
||||
echo " to the running terminal — it exits immediately with no report." >&2
|
||||
echo "" >&2
|
||||
echo " Recommended fix:" >&2
|
||||
echo " Add --kill-existing to your command." >&2
|
||||
echo " MT5 will restart, run the backtest, then stay open (ShutdownTerminal=0)" >&2
|
||||
echo " so you can inspect the Strategy Tester results in the GUI." >&2
|
||||
echo "" >&2
|
||||
echo " Alternative: close MT5 manually and re-run the backtest." >&2
|
||||
exit 1
|
||||
fi
|
||||
# `start` (no /wait): cmd.exe launches terminal64.exe and returns immediately.
|
||||
|
||||
echo " Launching MT5 in background (ShutdownTerminal=0) ..."
|
||||
# `start` (no /wait): cmd.exe launches terminal64.exe and exits immediately.
|
||||
cat > "$BAT_PATH" << 'BATEOF'
|
||||
@echo off
|
||||
cd /d "C:\Program Files\MetaTrader 5"
|
||||
@@ -393,7 +408,6 @@ BATEOF
|
||||
nohup ${MT5_ARCH} "${MT5_WINE}" cmd.exe /c 'C:\_mt5mcp_run.bat' &>/dev/null &
|
||||
LAUNCHER_PID=$!
|
||||
disown "$LAUNCHER_PID" 2>/dev/null || true
|
||||
# Give the launcher time to start terminal64.exe and exit
|
||||
sleep 5
|
||||
rm -f "$BAT_PATH"
|
||||
|
||||
|
||||
+182
-8
@@ -128,20 +128,47 @@ def _validate_environment() -> dict | None:
|
||||
|
||||
|
||||
def _check_symbol(symbol: str) -> tuple[str | None, list[str]]:
|
||||
"""Check if symbol exists in MT5 history dir. Returns (warning, suggestions)."""
|
||||
"""Check symbol against active server's history. Returns (warning, suggestions)."""
|
||||
terminal_dir = cfg('terminal_dir')
|
||||
if not terminal_dir:
|
||||
return None, []
|
||||
history_dir = Path(terminal_dir) / 'history'
|
||||
if not history_dir.is_dir():
|
||||
|
||||
ini = _read_terminal_ini()
|
||||
active_server = ini.get('LastScanServer', '')
|
||||
bases_dir = Path(terminal_dir) / 'Bases'
|
||||
|
||||
# Try active server first, then fall back to scanning all servers
|
||||
history_dir = None
|
||||
if active_server and (bases_dir / active_server / 'history').is_dir():
|
||||
history_dir = bases_dir / active_server / 'history'
|
||||
elif bases_dir.is_dir():
|
||||
for srv in bases_dir.iterdir():
|
||||
if (srv / 'history').is_dir():
|
||||
history_dir = srv / 'history'
|
||||
break
|
||||
|
||||
if not history_dir:
|
||||
return None, []
|
||||
|
||||
known = [d.name for d in history_dir.iterdir() if d.is_dir()]
|
||||
if not known or symbol in known:
|
||||
return None, []
|
||||
suggestions = difflib.get_close_matches(symbol, known, n=3, cutoff=0.6)
|
||||
sample = ', '.join(known[:5]) + ('...' if len(known) > 5 else '')
|
||||
warning = f"Symbol '{symbol}' not found in MT5 history. Available: {sample}"
|
||||
return warning, suggestions
|
||||
|
||||
suggestions = difflib.get_close_matches(symbol, known, n=3, cutoff=0.5)
|
||||
|
||||
# Check if symbol exists in any other server
|
||||
other_servers = []
|
||||
if bases_dir.is_dir():
|
||||
for srv in bases_dir.iterdir():
|
||||
if srv.name == active_server:
|
||||
continue
|
||||
if (srv / 'history' / symbol).is_dir():
|
||||
other_servers.append(srv.name)
|
||||
|
||||
msg = f"Symbol '{symbol}' not found in active server '{active_server}'. Available: {', '.join(known[:6])}{'...' if len(known) > 6 else ''}"
|
||||
if other_servers:
|
||||
msg += f". Found in: {', '.join(other_servers)}"
|
||||
return msg, suggestions
|
||||
|
||||
|
||||
# ── History helpers ───────────────────────────────────────────────────────────
|
||||
@@ -340,7 +367,7 @@ async def list_tools() -> list[types.Tool]:
|
||||
},
|
||||
"kill_existing": {
|
||||
"type": "boolean",
|
||||
"description": "Kill a running MT5 instance before launching. Default: false — passes config to the running instance (MT5 single-instance passthrough). Set true if passthrough does not work on your Wine setup."
|
||||
"description": "Kill a running MT5 instance before launching. REQUIRED when MT5 is already open — Wine does not support single-instance config passthrough. With shutdown=false (default), MT5 restarts, runs the backtest, then stays open so results are visible in the GUI."
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -468,6 +495,41 @@ async def list_tools() -> list[types.Tool]:
|
||||
),
|
||||
inputSchema={"type": "object", "properties": {}},
|
||||
),
|
||||
types.Tool(
|
||||
name="list_symbols",
|
||||
description=(
|
||||
"Detect the active MT5 broker session and list symbols that have local "
|
||||
"tick history available for backtesting. Also shows all broker servers "
|
||||
"found in the MT5 installation. Use this before run_backtest to confirm "
|
||||
"the correct symbol name for the connected broker."
|
||||
),
|
||||
inputSchema={
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"server": {
|
||||
"type": "string",
|
||||
"description": "Filter to a specific server name. If omitted, shows active server and all servers.",
|
||||
},
|
||||
},
|
||||
},
|
||||
),
|
||||
types.Tool(
|
||||
name="list_experts",
|
||||
description=(
|
||||
"List all compiled Expert Advisors (.ex5 files) found in the MT5 Experts "
|
||||
"directory, including those inside sub-folders. Returns the expert name to "
|
||||
"use in run_backtest and the sub-folder path if applicable."
|
||||
),
|
||||
inputSchema={
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"filter": {
|
||||
"type": "string",
|
||||
"description": "Optional substring filter on EA name (case-insensitive).",
|
||||
},
|
||||
},
|
||||
},
|
||||
),
|
||||
types.Tool(
|
||||
name="get_backtest_status",
|
||||
description=(
|
||||
@@ -1002,6 +1064,10 @@ async def call_tool(name: str, arguments: dict[str, Any]) -> list[types.TextCont
|
||||
result = await handle_compare_baseline(arguments)
|
||||
elif name == "compile_ea":
|
||||
result = await handle_compile_ea(arguments)
|
||||
elif name == "list_symbols":
|
||||
result = await handle_list_symbols(arguments)
|
||||
elif name == "list_experts":
|
||||
result = await handle_list_experts(arguments)
|
||||
elif name == "verify_setup":
|
||||
result = await handle_verify_setup(arguments)
|
||||
elif name == "get_backtest_status":
|
||||
@@ -1336,6 +1402,114 @@ async def handle_compile_ea(args: dict) -> dict:
|
||||
}
|
||||
|
||||
|
||||
def _read_terminal_ini() -> dict:
|
||||
"""Parse terminal.ini (UTF-16LE or UTF-8) into a flat key→value dict."""
|
||||
terminal_dir = cfg('terminal_dir')
|
||||
if not terminal_dir:
|
||||
return {}
|
||||
ini_path = Path(terminal_dir) / 'config' / 'terminal.ini'
|
||||
if not ini_path.exists():
|
||||
return {}
|
||||
try:
|
||||
raw = ini_path.read_bytes()
|
||||
text = raw.decode('utf-16') if raw[:2] in (b'\xff\xfe', b'\xfe\xff') else raw.decode('utf-8', errors='replace')
|
||||
except Exception:
|
||||
return {}
|
||||
result: dict = {}
|
||||
for line in text.splitlines():
|
||||
line = line.strip()
|
||||
if '=' in line and not line.startswith(';') and not line.startswith('['):
|
||||
k, _, v = line.partition('=')
|
||||
result[k.strip()] = v.strip()
|
||||
return result
|
||||
|
||||
|
||||
async def handle_list_symbols(args: dict) -> dict:
|
||||
env_error = _validate_environment()
|
||||
if env_error:
|
||||
return env_error
|
||||
|
||||
terminal_dir = cfg('terminal_dir')
|
||||
bases_dir = Path(terminal_dir) / 'Bases'
|
||||
|
||||
if not bases_dir.is_dir():
|
||||
return {'success': False, 'error': f'Bases directory not found: {bases_dir}'}
|
||||
|
||||
# Detect active server from terminal.ini
|
||||
ini = _read_terminal_ini()
|
||||
active_server = ini.get('LastScanServer', '')
|
||||
opt_mode = ini.get('OptMode', '0')
|
||||
|
||||
# Collect all servers and their symbols
|
||||
filter_server = args.get('server', '').lower()
|
||||
servers: list[dict] = []
|
||||
for server_dir in sorted(bases_dir.iterdir()):
|
||||
if not server_dir.is_dir():
|
||||
continue
|
||||
name = server_dir.name
|
||||
if filter_server and filter_server not in name.lower():
|
||||
continue
|
||||
history_dir = server_dir / 'history'
|
||||
symbols = sorted(d.name for d in history_dir.iterdir() if d.is_dir()) if history_dir.is_dir() else []
|
||||
servers.append({
|
||||
'server': name,
|
||||
'active': name == active_server,
|
||||
'symbol_count': len(symbols),
|
||||
'symbols': symbols,
|
||||
})
|
||||
|
||||
# Put active server first
|
||||
servers.sort(key=lambda s: (0 if s['active'] else 1, s['server']))
|
||||
|
||||
warnings = []
|
||||
if opt_mode == '-1':
|
||||
warnings.append('OptMode=-1 detected in terminal.ini — the CLEAN stage will reset this before backtest.')
|
||||
|
||||
return {
|
||||
'success': True,
|
||||
'active_server': active_server or '(unknown — open MT5 to connect)',
|
||||
'servers': servers,
|
||||
'warnings': warnings,
|
||||
'hint': 'Use the symbol name exactly as shown (e.g. "XAUUSD.cent" not "XAUUSD") in run_backtest.',
|
||||
}
|
||||
|
||||
|
||||
async def handle_list_experts(args: dict) -> dict:
|
||||
env_error = _validate_environment()
|
||||
if env_error:
|
||||
return env_error
|
||||
|
||||
terminal_dir = cfg('terminal_dir')
|
||||
experts_root = Path(cfg('experts_dir') or os.path.join(terminal_dir, 'MQL5', 'Experts'))
|
||||
|
||||
if not experts_root.is_dir():
|
||||
return {'success': False, 'error': f'Experts directory not found: {experts_root}'}
|
||||
|
||||
name_filter = args.get('filter', '').lower()
|
||||
experts: list[dict] = []
|
||||
|
||||
for ex5 in sorted(experts_root.rglob('*.ex5')):
|
||||
rel = ex5.relative_to(experts_root)
|
||||
expert_name = ex5.stem # filename without .ex5
|
||||
subfolder = str(rel.parent) if rel.parent != Path('.') else ''
|
||||
if name_filter and name_filter not in expert_name.lower():
|
||||
continue
|
||||
experts.append({
|
||||
'name': expert_name,
|
||||
'subfolder': subfolder,
|
||||
'run_backtest_expert': f'{subfolder}/{expert_name}' if subfolder else expert_name,
|
||||
'path': str(ex5),
|
||||
})
|
||||
|
||||
return {
|
||||
'success': True,
|
||||
'count': len(experts),
|
||||
'experts_root': str(experts_root),
|
||||
'experts': experts,
|
||||
'hint': 'Use the "run_backtest_expert" value as the expert parameter in run_backtest.',
|
||||
}
|
||||
|
||||
|
||||
async def handle_verify_setup(args: dict) -> dict:
|
||||
checks: dict = {}
|
||||
all_ok = True
|
||||
|
||||
Reference in New Issue
Block a user