Documentation
project_month_end
project_month_end MCP tool reference, parameters, return type, and safety hints.
What it does
Projects month end in the local Clovis ledger.
(year?: number | null, month?: number | null, expected_inflows?: Array<Record<string, unknown>> | null, expected_outflows?: Array<Record<string, unknown>> | null, expected_paychecks?: Array<Record<string, unknown>> | null, include_pending?: boolean, include_planned?: boolean, account_ids?: string[] | null, asset_account_ids?: string[] | null, liability_account_ids?: string[] | null, 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: nullexpected_inflowsoptionalExpected incoming cash items for projection.
Default: nullexpected_outflowsoptionalExpected outgoing cash items for projection.
Default: nullexpected_paychecksoptionalExpected paycheck or income items for projection.
Default: nullinclude_pendingoptionalIncludes pending transactions in the calculation.
Default: trueinclude_plannedoptionalIncludes planned transactions in the calculation.
Default: trueaccount_idsoptionalList of ledger account ids or account references.
Default: nullasset_account_idsoptionalAsset account ids to include in a projection.
Default: nullliability_account_idsoptionalList of identifiers from the local Clovis ledger.
Default: nullquote_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.
project_month_end
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "project_month_end",
"arguments": {
"quote_asset_id": "USD"
}
}