Time-weighted return, which removes the effect of contributions and withdrawals
One command in the Portfolio pack, available in the CLI, as an MCP tool and as a JavaScript import: portfolio twr.
What it needs, and why
Every input is checked before anything is calculated. valuations is required; the rest refine the answer.
| Input | Required | The question it asks | Why it matters |
|---|---|---|---|
valuations | yes | What was the portfolio worth at the start, at each contribution or withdrawal, and at the end? | A valuation is needed at every external cash flow. |
Requests it answers
- “how did the manager perform”
- “time-weighted return”
- “performance excluding deposits”
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.