Scenario runs
runStart, monitor, list, and retrieve scenario stress-test jobs for portfolio positions, including drawn paths, per-position results, and target-driver forecasts.
Instructions
Runs on the paths of a scenario. Actions: start, status, result, list.
Read guide(name="run-report") first. start draws the scenario's paths and
calculates a portfolio's positions — or the positions given in the call — on them,
as a job on the runs resource; status reports that job and what the run has
written, result the per-position results, the conditional forecast of the
targets (forecast.json: P5/P50/P95 of every target driver by month, in its own
unit; every driver when targets is omitted) and the report of a portfolio run,
list every run of the workspace. base_currency is the base of positions; a
portfolio brings its own.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"action": "<action>"
},
"name": "run"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The run id that status and result read. | |
| seed | No | The seed of the run: the same scenario, versions and seed give the same numbers. | |
| draws | No | How many paths the run draws. | |
| action | Yes | What to do: start a run, read its status or result, or list the runs. | |
| targets | No | The drivers the forecast reports, by id; every driver when omitted. An empty list is refused. | |
| scenario | No | The scenario the run calculates. | |
| portfolio | No | The stored portfolio the run values; give portfolio or positions, not both. | |
| positions | No | The positions the run values, given in the call; give portfolio or positions, not both. | |
| base_currency | No | The currency the notional of positions is stated in, RUB only: the models price against the rouble. A portfolio brings its own. | RUB |
| contributions | No | Whether the report also breaks the loss down by position. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||