cancel_run
ChatGPTCancel a queued or running MCP-originated hypothetical projection owned by this account.
clone_scenario
ChatGPTCreate a new mutable saved calculator scenario from a scenario, immutable run, or immutable public share snapshot.
compare_countries
ChatGPTUse this when a user asks how retiring in, or moving to, another country would change taxes and simulated outcomes. Compare supported countries by enqueueing a country sweep for a hypothetical projection; based on your inputs, the simulation shows status and polling details. For an inline simulation, omitting simulation_mode defaults to monte_carlo_iid.
compare_projections
ChatGPTAfter two runs or shares have both completed, call this once to place exactly two stored hypothetical projections side by side. Based on your inputs, the simulation shows each side's own rates, the gap between them, and where their stored percentile bands separate. It never starts or polls compute.
create_scenario
ChatGPTCreate a new mutable saved calculator scenario from a validated simulation payload.
create_share_link
ChatGPTCreate an externally visible, unlisted, immutable hypothetical-result share URL from exactly one completed run_id or the latest clean completed run for config_name. Anyone with the URL can view it; this never reruns a scenario.
create_variant
ChatGPTApply JSON Merge Patch to a scenario, run, or public share; optionally save and enqueue the resulting hypothetical projection. Lineage is persisted.
get_run_result
ChatGPTReturn compact stored results for a run; the simulation shows probabilities, terminal-wealth percentiles, and selected details based on your inputs. Succeeded sweeps include compact sweep_points by default; sweep_points is also an explicit sweep selector. For single simulations, use yearly_percentiles for year-by-year percentile bands. For sweeps, omit selectors or use sweep_points; yearly_percentiles is invalid.
get_scenario
ChatGPTRead a private mutable saved scenario and its normalized calculator inputs.
get_share
ChatGPTRead a compact immutable public hypothetical-result share summary. The default omits the full configuration and year-by-year arrays. Select simulation_snapshot for canonical inputs or yearly_percentiles for aligned years and p10/p50/p90 arrays. To change its inputs, create a private variant from the share directly.
get_supported_inputs
ChatGPTUse this first when a user asks about retirement timing, whether savings will last, sustainable spending, financial independence, or retiring abroad, before building a simulation payload. List supported calculator inputs, including countries, tax regimes, simulation modes, and the current assumptions version. The response also includes a ready-to-adapt minimal example payload and a short list of common input traps, including that omitted simulation_mode defaults to monte_carlo_iid for MCP runs. Read account_capabilities for available features and separate run/compute allowances. Optionally pass sweep arguments for a read-only compute-cost estimate.
list_runs
ChatGPTList private immutable hypothetical-run summaries without loading result or simulation payloads.
list_scenarios
ChatGPTList private saved calculator scenarios, which may later be updated or cloned.
list_shares
ChatGPTList immutable public hypothetical-result share snapshots owned by this account.
preview_conversion_tax
ChatGPTUse this when a user asks what a Roth conversion would cost in tax. Preview a Roth conversion tax calculation; based on your inputs, the hypothetical projection shows estimated tax impact without enqueueing compute.
preview_exit_tax
ChatGPTUse this when a user asks what exit or departure tax leaving a country would trigger. Preview a proposed relocation exit-tax calculation; based on your inputs, the hypothetical projection shows estimated tax impact without enqueueing compute.
render_projection
ChatGPTAfter reading or waiting for a completed run or immutable share, call this once to render its stored hypothetical projection. It never starts or polls compute.
run_simulation
ChatGPTUse this when a user asks whether their savings will last, when they could retire, or how a spending, saving, or retirement-age assumption changes their outcome. Do not use it for investment picks, live market data, or budgeting. Enqueue a hypothetical projection; based on your inputs, the simulation shows status and polling details after REST authorization checks run. For an inline simulation, omitting simulation_mode defaults to monte_carlo_iid.
run_sweep
ChatGPTGeneral sweep interface for the broader sweep-variable set and engine-generated points. Enqueue a hypothetical projection after REST tier and run-limit checks; use compare_countries for country comparisons. For an inline simulation, omitting simulation_mode defaults to monte_carlo_iid.
save_scenario
ChatGPTSave an unnamed run as a named scenario when the user asks to keep, name, or share it; otherwise runs stay unnamed and appear in the web app's run history. The history_url opens the stored hypothetical projection in the web app.
sensitivity_sweep
ChatGPTUse this when a user asks how outcomes change across several values of one assumption, such as spending levels or retirement ages. Preferred convenience wrapper for explicit values of its supported single non-country variables. Enqueue a hypothetical projection and return status and polling details. For an inline simulation, omitting simulation_mode defaults to monte_carlo_iid.
update_scenario
ChatGPTApply JSON Merge Patch to saved calculator inputs using optimistic concurrency. Runs and public shares cannot be updated.
wait_for_run
ChatGPTPoll a stored run for a bounded period and return what the simulation shows once available, or a still-running envelope. For single simulations use yearly_percentiles for year-by-year percentile bands. For sweeps omit selectors or use sweep_points; yearly_percentiles is invalid.