well_get_burn

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

Get the workspace's average monthly burn — the trailing average of actual outflows, the exact same computation and number the Well app's avg-burn KPI tile shows. Use this instead of summing transactions yourself. Returns `amount` (a positive magnitude, not a signed figure) and `currency`, plus the window it was measured over: `trailing_months` is the window length, `months_in_window` and `months_with_data` say how much of it actually carried outflow. `per_month` is the outflow of each month in that window, oldest first — the numbers the average is the mean of. A month with no recorded outflow is present with `0`, not omitted, so the series and the average always agree; do not drop those months when you describe the trend. Use it to say whether burn is rising or falling. `amount` is the figure the app shows, so it is the one you lead with and the one you call the burn — never put a figure computed from the series in its place. If a dark month looks like a data gap rather than a real month of no spend, say it may be a gap; `amount` stays the headline either way. State the window whenever you present the number. The average always divides by `months_in_window`, so when `months_with_data` is lower the figure is a real average over a window containing dark months, NOT an average of only the months that had spend — say so rather than presenting it as the typical monthly outflow. `unavailable: true` means `amount` is a placeholder rather than a measurement (e.g. nothing has synced yet) — a burn of zero standing on nothing measured is not a reading, so say that instead of reporting a €0 burn. `partial: true` means individual transactions were excluded from an otherwise real figure (e.g. a missing FX rate); disclose the exclusion count and any `hints`. Pass `year` + `month` to measure a past period instead of the live window, and `months_back` to change the window length (default 3). For months of cash left, call `well_get_runway` — it composes this burn with the cash position. For what the spend is made of, call `well_get_cost_structure`. Neither is a decomposition of the other: cost structure covers a single closed month and will not sum to a trailing average. 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).