get_backtest MCP Tool

Back to MCP catalog

get_backtest

Fetch a backtest's summary, and optionally page its full trade list or OHLC bars.

Area

Backtesting & Validation

Group

Backtests

Access

Read

Risk

Read-only

Details

Full description

Get the details and results of a backtest. By default returns the summary (statistics, capped trades, warnings).

Trades — in the default summary they live at results.trades (NOT top-level trades). When capped (20 in summary mode, 500 in full mode), results.trade_count and results.trades_truncated flag the truncation. Use include=["trades"] with trades_offset / trades_limit to page every trade under a top-level trades key.

OHLC — include=["ohlc"] adds OHLCV bars + trade markers under a top-level ohlc key. For portfolio/universe (per-sleeve) runs, sleeve_id is REQUIRED; omitting it returns the list of available sleeve_ids instead of bars. Omit sleeve_id on single-symbol runs.

get_backtest(backtest_id)                                       # summary
get_backtest(backtest_id, include=["trades"], trades_offset=0, trades_limit=100)
get_backtest(backtest_id, include=["ohlc"], sleeve_id="...")    # per-sleeve bars

Capabilities

Bounded options and operating modes surfaced above the full JSON schema.

No bounded capability options are declared for this tool.

Required Inputs

FieldTypeDescription

backtest_idstringBacktest identifier

Optional Inputs

FieldTypeDescription

detailanyOf (2 variants)Result detail: 'summary' (default, no blueprints, trades capped at 20), 'full' (includes blueprints, trades capped at 500), 'status' (metadata only, for polling), 'none' (same as status, legacy).

includeanyOf (2 variants)Optional add-ons. 'trades' appends a paginated full trade list under the top-level 'trades' key (see trades_offset/trades_limit). 'ohlc' appends OHLCV bars + trade markers under the top-level 'ohlc' key (see max_bars/ohlc_offset/ohlc_limit). Omit for the summary-only response.

include_indicatorsanyOf (2 variants)Indicator data: 'none' (default) or 'summary' (statistical summary).

max_barsintegerMaximum number of OHLC bars to return when downsampling. Used when include contains 'ohlc' and ohlc_limit is unset.

ohlc_limitanyOf (2 variants)When set, return a contiguous OHLC slice bars[ohlc_offset : ohlc_offset+ohlc_limit] without downsampling. Each returned bar carries its engine-true bar_index. Leave unset for the downsampled chart view.

ohlc_offsetintegerStarting bar index for paginated full-resolution OHLC. Only takes effect when ohlc_limit is also set.

sleeve_idanyOf (2 variants)Sleeve to chart when include=['ohlc'] on portfolio/universe (per_sleeve) runs. REQUIRED for per_sleeve runs; omit on single-symbol runs. Omit on a per_sleeve run to receive the list of available sleeve_ids under the 'ohlc' key.

trades_limitintegerMax trades to return per page (1-500, default 50). Used when include contains 'trades'.

trades_offsetintegerTrade index to start from (0-based). Used when include contains 'trades'.