Equity Guard
3 tools — auto-generated from the MCP server's tool schemas.
Generated
This page is generated from packages/server/mcp/src/tools/*.ts by pnpm docs:generate-tools. Do not edit it by hand — edit the tool's description/schema in source and regenerate.
get_equity_guard_status
Returns the current equity guard: config, status (armed / breached / breached_pending / none), day_start_equity anchor, current equity, daily P&L percent, and the equity level at which the guard breaches. Requires the trade capability.
Parameters
No parameters.
remove_equity_guard
Removes the equity guard. If the guard is currently breached (or breached_pending), removal requires confirm=true — this prevents silently disabling an active safety rail; without it the call returns CONFIRM_REQUIRED. Requires the trade capability.
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
confirm | boolean | No | false | — |
set_equity_guard
Configures an account-level circuit breaker enforced server-side (survives this session): when equity falls max_daily_loss_percent below the daily anchor (or max_total_drawdown_percent below initial equity), the guard breaches. breach_action: close_all = close all positions then block new live trades until the daily reset; block_new = block only; notify = record an alert event only (see poll_alerts). Evaluation runs on a ~30s sampling loop while the terminal is connected; if disconnected at breach time, the trade block still applies and close_all executes on reconnect. This is best-effort protection above the broker's own stop-out, not a replacement for stop losses. One guard per license — calling again replaces it. Requires the trade capability.
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
max_daily_loss_percent | number | Yes | — | — |
max_total_drawdown_percent | number | No | — | — |
breach_action | string | Yes | — | (one of: close_all, block_new, notify) |
reset_timezone | string | No | "UTC" | IANA timezone for the daily reset boundary, e.g. 'UTC' or 'Europe/Prague'. |
terminal_id | string | No | — | — |