Documentation
cash_runway
cash_runway MCP tool reference, parameters, return type, and safety hints.
What it does
Estimates how long spendable cash can cover burn, based on the selected assumptions.
(year?: number | null, month?: number | null, as_of?: string | null, asset_account_ids?: string[] | null, liability_account_ids?: string[] | null, earmarks?: Array<Record<string, unknown>> | null, include_pending?: boolean, include_planned?: boolean, include_partial_month?: boolean, reserve_remaining_budget?: boolean, include_sources?: boolean, summary?: boolean, trailing_months_short?: number, trailing_months_long?: number, discretionary_multiplier?: number, quote_asset_id: string) => Record<string, unknown>Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.
When to use it
Use this section to decide whether the tool fits the user request before calling it.
Before calling
Agents should gather these facts or confirmations first.
Have exact values for required inputs: quote_asset_id.
Choose the report currency or asset explicitly; Clovis does not infer report currency.
Parameters
Required inputs are marked clearly. Optional inputs can usually be omitted unless the workflow needs them.
yearoptionalFour-digit year.
Default: nullmonthoptionalMonth number from 1 to 12.
Default: nullas_ofoptionalDate to calculate balances through, usually YYYY-MM-DD.
Default: nullasset_account_idsoptionalAsset account ids to include in a projection.
Default: nullliability_account_idsoptionalList of identifiers from the local Clovis ledger.
Default: nullearmarksoptionalInput used by this tool.
Default: nullinclude_pendingoptionalIncludes pending transactions in the calculation.
Default: falseinclude_plannedoptionalIncludes planned transactions in the calculation.
Default: falseinclude_partial_monthoptionalBoolean switch for this workflow.
Default: falsereserve_remaining_budgetoptionalBoolean switch for this workflow.
Default: trueinclude_sourcesoptionalBoolean switch for this workflow.
Default: falsesummaryoptionalBoolean switch for this workflow.
Default: falsetrailing_months_shortoptionalNumeric value used by this workflow.
Default: 3trailing_months_longoptionalNumeric value used by this workflow.
Default: 6discretionary_multiplieroptionalNumeric value used by this workflow.
Default: 0.5quote_asset_idrequiredAsset or currency used to quote report values. Clovis does not infer this.
Agent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
cash_runway
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "cash_runway",
"arguments": {
"quote_asset_id": "USD"
}
}