well_get_cash_forecast

io.github.WellApp-ai/well-mcp · Verify this server

Get the workspace's cash-position forecast — trailing actual month-end balances plus a worst-case projection forward — the exact same series the Well app's "Cash Position Forecast" chart draws. Use this instead of projecting cash forward yourself from a cash figure and a burn rate. Returns `entries`, one per month, oldest first, each `{ month, actuals, projection }` where `month` is `YYYY-MM`: - `actuals` is the settled cash position at that month's end, and is null for future months. - `projection` is the worst-case value at that month's end, and is null for past months. So the series has exactly one turn: actuals up to the present, projection after it. Do not fill the nulls in or treat a null as a zero. The projection is explicitly WORST CASE — it assumes NO revenue and declines at the trailing average burn until it reaches zero, where it stays clamped. Say so whenever you present it. It is a floor, not a forecast of what will happen, and a workspace that expects income will not follow it. Takes no period. A worst-case projection has no coherent meaning for a month whose real outcome is already known, so this always returns the live forecast — unlike `well_get_cash_position` and `well_get_cost_structure`, which do accept `year`/`month`. If `hints` are present (a short actuals window, excluded accounts, or a burn-coverage gap), disclose them rather than presenting the series as unconditionally complete. For the single months-of-cash-left figure call `well_get_runway`; for the burn rate driving the decline call `well_get_burn`. Call this directly — no other tool call is needed first (workspace is resolved from the caller's authorized token, same as every other well_* tool).