Alert
4 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.
cancel_alert
Cancels an active alert by alert_id (from create_alert or list_alerts). Returns ALERT_NOT_FOUND if the alert does not exist, already fired, or was already cancelled. Available at Pro+ tier.
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
alert_id | string | Yes | — | — |
create_alert
Creates a persistent server-side alert, evaluated every ~30 seconds while the terminal is connected (not tick-precise). Types: price (level above/below), indicator (value or cross vs threshold), position_event (sl_hit / tp_hit / position_closed, optional ticket filter), margin_level (below %). mode=once fires a single time; mode=recurring re-arms after cooldown_seconds. Fired events are queued durably — retrieve them with poll_alerts. Active-alert caps by tier: Pro 10, Team 50, Enterprise 200. Available at Pro+ tier.
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | — | (one of: price, indicator, position_event, margin_level) |
condition | object | Yes | — | Condition object; shape depends on type — see tool description. |
mode | string | No | "once" | (one of: once, recurring) |
cooldown_seconds | integer | No | 300 | — |
note | string | No | — | — |
terminal_id | string | No | — | — |
list_alerts
Lists all alerts for this license with status (active/fired/cancelled), condition, mode, fire count, and last_evaluated_at (stale while the terminal is disconnected — evaluation pauses). Available at Pro+ tier.
Parameters
No parameters.
poll_alerts
Drains undelivered fired-alert events (oldest first) and marks them delivered. Each event carries event_id, the alert's condition echo, the triggering values, and the fired timestamp. Events are retained 7 days; pass include_delivered=true to see the retained history. Call this periodically — alerts are pull-based, nothing is pushed. Available at Pro+ tier.
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
include_delivered | boolean | No | false | — |