yax_forecast_cash_flow
Read-onlyIdempotent
Generate week-by-week cash flow forecasts across base, optimistic, and pessimistic scenarios. Returns inflow/outflow projections and a Filecoin-anchored report for planning or lending.
Instructions
Generates a week-by-week cash flow forecast across base, optimistic, and pessimistic scenarios. Returns inflow/outflow projections and a Filecoin-anchored report CID for board or lender use.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| horizon_weeks | No | Number of weeks to forecast. Defaults to 13 (one quarter). | |
| scenarios | No | Scenarios to model: ['base', 'optimistic', 'pessimistic']. Defaults to all three. | |
| include_ar | No | Include accounts-receivable projections. Defaults to true. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | True if forecast succeeded. | |
| run_id | No | Run ID for receipt retrieval. | |
| forecast | No | Week-by-week cash flow projection array with inflows, outflows, and net position per scenario. | |
| report_cid | No | Filecoin CID of the anchored forecast report. |
Implementation Reference
- sdk-ts/src/index.ts:348-349 (handler)The forecastCashFlow SDK method that calls 'yax_forecast_cash_flow' via JSON-RPC. This is the typed client-side invocation of the MCP tool.
forecastCashFlow(args: { horizon_days?: number; scenarios?: string[] } = {}): Promise<GenericToolResponse> { return this.call("yax_forecast_cash_flow", args as Record<string, unknown>); - sdk-ts/src/index.ts:348-349 (registration)The tool name 'yax_forecast_cash_flow' is registered/used in the SDK's call method. No server-side registration code was found in this codebase — the actual handler lives on the remote YieldAgentX402 MCP server at https://api.yieldagentx402.app/mcp.
forecastCashFlow(args: { horizon_days?: number; scenarios?: string[] } = {}): Promise<GenericToolResponse> { return this.call("yax_forecast_cash_flow", args as Record<string, unknown>);