project_wealth_plan
Run RetireCrunch's full year-by-year Wealth Plan projection for a household. Models earned income, pensions, expenses, portfolio growth (accumulating, distributing, or accumulating until a switch year), mortgage amortization, optional property sale, and region-aware tax (US uses 2026 federal+state brackets; other regions use a flat rate). Returns a compact summary with 5-year milestones by default, or the full annual array when yearly_detail=true.
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": {
"start_year": "<start_year>",
"retirement_year": "<retirement_year>"
},
"name": "project_wealth_plan"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | Country regime — drives tax model (US uses bracket-based federal/state; others a flat rate). | GENERIC |
| currency | No | USD | |
| start_year | Yes | First year of the projection (typically the current year). | |
| yearly_detail | No | When true, include the full year-by-year array in the response. When false (default), return a compact summary plus 5-year milestones. | |
| household_type | No | single | |
| inflation_rate | No | Annual inflation %. | |
| retirement_year | Yes | Year retirement begins. | |
| current_mortgage | No | ||
| current_property | No | ||
| current_liquidity | No | ||
| income_yield_rate | No | Annual payout % of the portfolio while distributing. | |
| estimated_tax_rate | No | Pre-retirement effective tax rate (%). | |
| plan_horizon_years | No | Total years to project from start_year. | |
| property_sale_year | No | ||
| current_living_costs | No | Annual general living expenses today. | |
| portfolio_volatility | No | Return std dev %; 0 = deterministic. | |
| current_earned_income | No | Annual gross earned income today. | |
| portfolio_return_mode | No | What the portfolio does with its return. 'accumulating': everything stays invested and compounds, nothing is paid out (shortfalls are drawn from cash, then the portfolio). 'distributing': pays out income_yield_rate % of its value every year from start_year as investment income; the rest stays invested. 'switch': accumulating until portfolio_switch_year, distributing from then on. If omitted: 'switch' when portfolio_switch_enabled is true (the legacy default), 'accumulating' when it is false. | |
| portfolio_return_rate | No | Annual real portfolio return %. | |
| portfolio_switch_year | No | 'switch' mode: first year the portfolio pays out. Defaults to retirement_year if omitted. | |
| property_sale_enabled | No | ||
| current_other_expenses | No | Annual other expenses today. | |
| current_housing_expenses | No | Annual housing expenses today. | |
| portfolio_switch_enabled | No | Legacy: prefer portfolio_return_mode. Only read when portfolio_return_mode is omitted. | |
| post_retirement_tax_rate | No | Post-retirement effective tax rate (%). | |
| property_sale_destination | No | liquidity | |
| current_investment_portfolio | No | ||
| partner_survivor_expense_factor | No | ||
| partner_early_death_years_before_end | No |