MayRetire

Calculate an inline plan deterministically. Start with a compact summary; request a named view and bounded years or ages only for focused annual detail. Screen candidates cheaply before Monte Carlo.

calculate_plan_payload

Request cancellation of a running planning job.

cancel_plan_job

Get a planning job state, queue position if waiting, and progress if running.

status_plan_job

Compare an inline baseline plan with up to eight independent merge-patch variations using deterministic calculations. No plan files are written.

compare_plan_payloads

Optional UI handoff only: encode an already available inline plan as a MayRetire /view URL fragment when the user asks to open it. Editing tools return plan JSON directly; this tool does not save a plan or launch a browser.

plan_handoff_url

Create a neutral MayRetire plan in memory, applying an optional guided request and portfolio presets. Ask for household facts first; never invent balances or benefits. Returns the complete plan and validation issues.

create_plan_payload

Describe MayRetire fields or collections before editing unfamiliar plan settings.

describe

Apply a patch and/or item operations to an inline MayRetire plan. Returns the complete modified plan, changes, and validation warnings without writing a file.

edit_plan_payload

Explain why withdrawals occurred in one plan year or at one age, with decision-trace evidence. Deterministic by default; set trialSeed for one simulated return sequence.

explain_plan_payload

Evaluate a bounded set of supplied retirement-plan variations and return compact candidate results. Provide exactly one of request.variables or request.scenarios. Returns a job ID; poll status_plan_job, then result_plan_job, and retrieve selected plans with get_candidate_plan. Screen deterministically before enabling per-candidate simulation or stress.

start_exploration_job