Analytics

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.

`check_order`

Checks whether an order can be placed without sending it. Supports both market and pending order types. Returns { feasible, required_margin, free_margin, estimated_cost, reason? }.

Parameters

Name	Type	Required	Default	Description
`symbol`	string	Yes	—	—
`order_type`	string	Yes	—	(one of: `BUY`, `SELL`, `BUY_LIMIT`, `BUY_STOP`, `SELL_LIMIT`, `SELL_STOP`)
`volume`	number	Yes	—	—
`price`	number	No	—	—
`terminal_id`	string	No	—	—

`get_pnl_by_symbol`

Returns P&L broken down per trading symbol. Result: { items: [{ symbol, pnl, trades }] } sorted by |pnl| descending.

Parameters

Name	Type	Required	Default	Description
`from_date`	string	No	—	—
`to_date`	any	No	—	—
`terminal_id`	string	No	—	—

`get_pnl_by_time`

Returns P&L bucketed into time intervals. Result: { items: [{ period_start, pnl, trades }] } sorted chronologically.

Parameters

Name	Type	Required	Default	Description
`period`	string	No	`"DAY"`	(one of: `DAY`, `WEEK`, `MONTH`)
`from_date`	string	No	—	—
`to_date`	any	No	—	—
`terminal_id`	string	No	—	—

`get_tick_history`

Returns a sequence of raw ticks for a symbol. Result: { ticks: [{ time, bid, ask, last, volume }] }.

Parameters

Name	Type	Required	Default	Description
`symbol`	string	Yes	—	—
`count`	integer	No	`100`	—
`from_date`	string	No	—	—
`terminal_id`	string	No	—	—

`get_trade_stats`

Returns aggregate statistics over closed trades: total_trades, win/loss counts, win_rate, avg_profit, avg_loss, profit_factor, total_pnl.

Parameters

Name	Type	Required	Default	Description
`symbol`	string	No	—	—
`from_date`	string	No	—	—
`to_date`	any	No	—	—
`terminal_id`	string	No	—	—

On this page