Money-weighted return (XIRR) from dated contributions, distributions and ending value
One command in the Portfolio pack, available in the CLI, as an MCP tool and as a JavaScript import: portfolio irr.
What it needs, and why
Every input is checked before anything is calculated. cashFlows is required; the rest refine the answer.
| Input | Required | The question it asks | Why it matters |
|---|---|---|---|
cashFlows | yes | What were the dated contributions (negative) and distributions (positive), plus the current value as a final flow? | The rate is solved from the timing and size of each flow. |
Requests it answers
- “what is the IRR on this fund”
- “money-weighted return”
- “what did the client actually earn”
An agent with this pack loaded picks the command from phrasing like that, asks for whatever input is missing, and reports the figures with the method that produced them.
Limits it inherits from wealth-portfolio
- Tax-loss harvesting checks only purchases in the 30 days *before* the sale, across the lots supplied. Confirm separately that nothing substantially identical is bought in the 30 days after, including in IRA and spouse accounts. Replacement candidates track a different index, but whether a fund is "substantially identical" is a judgment for the advisor or tax professional. No replacement is suggested for total-bond funds.
- Backtests use approximate embedded annual returns and capture drawdowns at year-end only.
- Forward-simulation regime assumptions are illustrative, not forecasts; pass your firm's capital market assumptions for client work.
- VaR is parametric normal and only as good as the volatility you supply.
The full pack, its other 10 commands and what it deliberately leaves alone are on the Portfolio page.