Skip to main content
Glama
Finance Toolkit

Finance Toolkit

performance

Read-onlyIdempotent

Calculate risk-adjusted investment metrics such as Sharpe, Sortino, beta, alpha, CAPM, Treynor, and tracking error for selected tickers, periods, and benchmarks.

Instructions

Pre-computed risk-adjusted performance metrics (Sharpe ratio incl. standard/lo/adjusted/probabilistic/deflated methods, Sortino ratio, Alpha, Jensen's Alpha, Beta, CAPM, Treynor ratio, M2 ratio, Tracking Error, Information Ratio, Fama-French factors, period Returns, Excess Returns — get_beta takes method='blume' (Bloomberg adjusted), 'vasicek', 'dimson' (lags=), 'scholes_williams', 'upside' or 'downside' besides the default 'ols'; Returns/Excess Returns support cumulative=true for the compounded growth of 1 from the start of the date range, so the first value includes the first period's return; returns start from the first close on or after start_date, so for a year-to-date return set start_date to the last trading day of the previous year). Beta, CAPM, Alpha, Jensen's Alpha, Treynor, Sortino, M2, Tracking Error and Information Ratio support rolling=N for a rolling N-period value spanning the full history instead of one value per period (e.g. period='monthly', rolling=6 for a rolling 6-month figure). Sharpe ratios are per observation (e.g. per day within the period) unless annualize=true; method='lo' is Lo's (2002) annualized Sharpe ratio corrected for autocorrelated returns (lags= autocorrelation lags); it needs 30 or more returns per period, so use quarterly or yearly periods or rolling= of 30 or more. get_sharpe_ratio_standard_error (method='iid', 'non_normal' for skewed and fat-tailed returns, or 'gmm' for autocorrelated returns too) is on the per-observation scale. get_minimum_track_record_length is the number of return observations (trading days per period, or periods with rolling=) needed before the Sharpe ratio is significantly above benchmark_sharpe_ratio (0 by default, per observation) at confidence_level (0.95); empty when the Sharpe ratio is not above it. get_coskewness and get_cokurtosis measure how each ticker moves with the squared and cubed moves of the benchmark (method='standardized' or 'residual', Harvey-Siddique). Requires tickers='AAPL' — use comma-separated values for multiple tickers. Supports period='daily' only together with rolling=N (e.g. period='daily', rolling=60 for a rolling 60-day figure); per-period results use weekly, monthly, quarterly, or yearly. get_style_analysis and get_return_statistics also take period='daily' without rolling. get_beta_implied_return splits each period's return into Beta × Benchmark Return (the Implied Return) and the Residual, the asset's own part, with the Beta estimated from the beta_window (252 by default) daily returns before the period; it is daily by default (limit=-1 for the latest day's move) and also takes weekly, monthly, quarterly or yearly. Residual Value is the Residual in money (times the market cap at the previous close, in the ticker's trading currency; empty for ETFs and indices), Residual Percentile the share of earlier residuals that were smaller in size and Residual Largest Since the date of the last residual as large in the same direction ('the largest stock-specific fall since'), so limit=-1 judges the latest move against the whole history from start_date (two or more years back: a year for the Beta and a year of residuals for the Percentile). The factor models (get_fama_and_french_model, get_carhart_four_factor_model, get_factor_asset_correlations, get_factor_correlations) take region='United States' (default), 'Developed', 'Developed ex US', 'Europe', 'Japan', 'Asia Pacific ex Japan' or 'North America' for Ken French's regional factors. get_style_analysis is Sharpe's returns-based style analysis: every ticker gets its weights in the style indices, by default IWD, IWF, IWN, IWO (US large and small cap value and growth), AGG (bonds) and BIL (cash), or those of style_tickers= (e.g. style_tickers='IWF,IWD,AGG'; tickers outside the call are retrieved), with its in-sample R Squared, selection return and tracking error; window= for rolling weights, which adds Sharpe's out-of-sample selection return per period. get_factor_analysis: factor analysis (predictive power) of the performance metrics across tickers: do the tickers that score high on one go on to return more than those that score low? Needs tickers= with at least ten, preferably twenty or more tickers. metrics= a performance metric name, a comma-separated list, or 'all' (the default: returns, excess return, beta, Sharpe, Sortino, Treynor, information ratio, tracking error, Jensen's alpha, Calmar, Omega, win rate); each is measured within every period. Returns a row per metric and horizon: the mean information coefficient (IC, the Spearman rank correlation between the metric and the later returns), its standard deviation, IC information ratio, t-statistic, p-value, share of positive periods, number of periods, the Top Minus Bottom quantile spread, quantile turnover and rank autocorrelation. detail='information_coefficient', 'quantile_returns', 'quantile_turnover' or 'rank_autocorrelation' returns that part per period (or per quantile) for a single metric. period= sets how often it is evaluated (monthly by default), horizons= the periods ahead (e.g. 12 or [1, 12]), quantiles= the number of quantiles (5). Other parameters pass to the metrics. The IC is reported as measured: a negative IC for get_returns is short-term reversal. get_kelly_criterion is the share of capital to risk that maximizes log growth: method='discrete' (default; win rate - loss rate / payoff ratio) or 'continuous' (average excess return / variance), fraction=0.5 for half Kelly; per period, within_period=false over the whole history, or rolling=N. get_return_statistics (daily returns over the whole range by default; within_period=true per year) gives the absolute win rate, average win and loss, payoff ratio, profit factor, expectancy, longest winning and losing streaks, recovery factor and common sense ratio. get_morningstar_risk_adjusted_return (MRAR, the certainty-equivalent return Morningstar ranks funds on, gamma=2) and get_morningstar_risk (Morningstar Return minus MRAR) use monthly total returns in excess of the risk-free rate (risk_free_rate='13w' for the Treasury bill rate Morningstar uses), per calendar year (period='yearly' or 'quarterly'), over the whole range with within_period=false, or rolling=36, 60 or 120 for Morningstar's three, five and ten year figures at every month end.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "indicator": "<indicator>"
    },
    "name": "performance"
  }
}

Input Schema

NameRequiredDescriptionDefault
lagNoNumber of periods to lag when computing growth rates.
lagsNoThe number of lags (past periods) the test or model uses, e.g. 1 or 5. Leave unset to use the default of the indicator you selected. Defaults are None for get_sharpe_ratio, get_sharpe_ratio_standard_error; 1 for get_beta.
rankNotrue ranks the tickers (or countries) within every period, from the highest value (rank 1) to the lowest, and compares each with its neighbour toward the middle of the ranking: the Difference (in points for returns) and the Multiple (only when both have the same sign), so the first and last rank show how far the best and the worst stand apart, e.g. a fall more than twice as large as the next one. Needs a value per period and ticker; pick one field with show_columns where there are more.
alphaNoFor get_rachev_ratio: The confidence level used for both tails (e.g. 0.05 for the best/worst 5% of outcomes). For get_starr_ratio: The confidence level used for the CVaR calculation (e.g. 0.05 for the worst 5% of outcomes).
gammaNoThe risk aversion, 0 or higher.
limitNoThe rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead, and rows per ticker (an earnings calendar) are selected per ticker. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length. 0 returns every row.
orderNoThe order of the lower partial moment used in the denominator.
columnNoThe price column to use, e.g. 'Close' or 'Adj Close'; for get_factor_analysis the output of a metric with several, e.g. 'Signal Line'.
detailNoget_factor_analysis only: 'information_coefficient', 'quantile_returns', 'quantile_turnover' or 'rank_autocorrelation' returns that part for a single metric instead of the summary.
growthNoReturn period-over-period growth rates instead of absolute values.
methodNo"standardized" or "residual". Leave unset to use the default of the indicator you selected. Defaults are 'standardized' for get_cokurtosis, get_coskewness; 'discrete' for get_kelly_criterion; 'iid' for get_sharpe_ratio_standard_error; 'multi' for get_fama_and_french_model; 'ols' for get_beta; 'standard' for get_sharpe_ratio.
periodNoObservation frequency, e.g. 'daily', 'weekly', 'monthly', 'quarterly', or 'annual' (supported values differ per method). Leave unset to use the default of the indicator you selected. Defaults differ between indicators.
regionNoThe region whose factors to use: "United States", "Developed", "Developed ex US", "Europe", "Japan", "Asia Pacific ex Japan" or "North America" (the factors of Ken French's library for that region's stocks). Every region's factors are U.S. dollar returns with the U.S. one-month Treasury bill as...United States
windowNoThe number of periods the indicator looks back over, e.g. 14 or 20.
metricsNoget_factor_analysis only: the metric(s) to analyse, a method name such as 'get_price_to_earnings_ratio', a comma-separated list, or a collection of the tool (see the tool description), e.g. 'profitability'.all
rollingNoRolling window size in number of periods. When set, the metric is computed over a smoothly overlapping trailing window across the full history (e.g. period='monthly' and rolling=6 gives a rolling 6-month value) instead of one value per period, or (for economics indicators) a simple moving average used to smooth the raw series. Leave unset to use the default of the indicator you selected. Defaults differ between indicators.
tickersNoComma-separated ticker symbols, e.g. 'AAPL,MSFT,GOOGL'.
end_dateNoEnd of the date range in YYYY-MM-DD format; left empty, today (or the indicator's own window).
fractionNoThe share of the full Kelly bet, e.g. 0.5 for half Kelly.
horizonsNoThe number of periods the forward returns cover.
n_trialsNoThe number of independent (or effectively independent) strategy variations, parameter combinations, or lookback windows tried before arriving at the reported Sharpe ratio. Only used when method="deflated". Pass this explicitly whenever the actual number of trials is known.
annualizeNoSet to true to annualize a Sharpe ratio (by default it is per observation, e.g. per day, so roughly sqrt(252) smaller than the annualized figure).
indicatorYesName of the specific metric to calculate, one of the listed values. Required — search_metrics finds the indicator (and its tool) for a metric by name.
quantilesNoThe number of quantiles the tickers are sorted into per period.
quarterlyNoReturn quarterly data instead of annual when True.
adjustmentNoThe fixed adjustment added to the Average Drawdown, conventionally 0.1 (10%).
cumulativeNoReturn the cumulative value compounded over time instead of the discrete value per period. Always rebased to start at 1 at the beginning of the selected date range.
start_dateNoStart of the date range in YYYY-MM-DD format; left empty, five years before today (or the indicator's own window).
beta_windowNoThe number of daily returns the Beta is estimated on.
standardizeNoReturn the Z-Score (standard score) instead of the raw values, i.e. how many standard deviations each value is from the mean of its own series. When combined with growth=True, the growth values are standardized instead of the raw values.
show_columnsNoComma-separated names to filter the output. For historical data use the key names visible in any response record (e.g. 'Close,Volume,Return'). For financial statements use the 'metric' field values from the response (e.g. 'Revenue,Net Income,EBITDA'). Call the tool once without this parameter to see all available names, then repeat with show_columns to reduce response size and token usage.
periods_apartNoThe number of periods between the dates the quantile turnover and the rank autocorrelation compare.
style_tickersNoThe tickers of the style indices, as a list or a comma-separated string.
trials_windowNoThe window size of the auxiliary rolling Sharpe ratio series that approximates `Var[SR_trials]` and the default `n_trials`. Only used when method="deflated". It counts observations of the returns the Sharpe ratio is computed from: daily (or intraday) observations for the Sharpe ratio per period,...
within_periodNoWhether to calculate the risk of the months within each period or of all months in the range. Leave unset to use the default of the indicator you selected. Defaults are True for get_burke_ratio, get_calmar_ratio, get_gain_to_pain_ratio, get_kelly_criterion, get_morningstar_risk, get_morningstar_risk_adjusted_return, get_omega_ratio, get_rachev_ratio, get_starr_ratio, get_sterling_ratio; False for get_return_statistics.
risk_free_rateNoThe US Treasury yield used as the risk-free rate: '13w' (the 13-week bill), '5y', '10y' (default) or '30y'.10y
benchmark_tickerNoTicker used as the market benchmark, e.g. 'SPY' or '^GSPC'; 'None' for no benchmark.SPY
confidence_levelNoThe confidence level.
exclude_risk_freeNoWhether to exclude the risk-free rate from the results.
show_full_resultsNoWhether to show the actual and benchmark returns next to the Alpha.
factors_to_calculateNoComma-separated factor names to include in the calculation.
benchmark_sharpe_ratioNoFor get_minimum_track_record_length: The benchmark Sharpe ratio SR*, on the scale of one observation (e.g. 1 / SQRT(252) for an annualized benchmark of 1 on daily returns). For get_sharpe_ratio: The hypothesized or benchmark Sharpe ratio (SR*) to test the observed Sharpe ratio against. Only used when method="probabilistic".
include_daily_residualsNoWhether to also return the pointwise (daily) regression residuals as a second DataFrame.
minimum_acceptable_returnNoThe minimum acceptable return (MAR) threshold below which returns are considered downside, e.g. 0.0 for downside relative to a zero return.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.3.4
    • addedInput schema / properties / rank
      Added value: +{
      +  "default": false,
      +  "description": "true ranks the tickers (or countries) within every period, from the highest value (rank 1) to the lowest, and compares each with its neighbour toward the middle of the ranking: the Difference (in points for returns) and the Multiple (only when both have the same sign), so the first and last rank show how far the best and the worst stand apart, e.g. a fall more than twice as large as the next one. Needs a value per period and ticker; pick one field with show_columns where there are more.",
      +  "type": "boolean"
      +}
  2. Changed14 schema fields changedv2.3.3
    • changedInput schema / properties / benchmark_sharpe_ratio / description
      Previous value: -"The hypothesized or benchmark Sharpe ratio (SR*) to test the observed Sharpe ratio against. Only used when method=\"probabilistic\"."New value: +"For get_minimum_track_record_length: The benchmark Sharpe ratio SR*, on the scale of one observation (e.g. 1 / SQRT(252) for an annualized benchmark of 1 on daily returns). For get_sharpe_ratio: The hypothesized or benchmark Sharpe ratio (SR*) to test the observed Sharpe ratio against. Only used when method=\"probabilistic\"."
    • addedInput schema / properties / confidence_level
      Added value: +{
      +  "default": 0.95,
      +  "description": "The confidence level.",
      +  "type": "number"
      +}
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_alpha",
      -  "get_appraisal_ratio",
      -  "get_beta",
      -  "get_beta_implied_return",
      -  "get_burke_ratio",
      -  "get_calmar_ratio",
      -  "get_capital_asset_pricing_model",
      -  "get_carhart_four_factor_model",
      -  "get_compound_growth_rate",
      -  "get_correlation_matrix",
      -  "get_covariance_matrix",
      -  "get_downside_capture_ratio",
      -  "get_excess_return",
      -  "get_factor_analysis",
      -  "get_factor_asset_correlations",
      -  "get_factor_correlations",
      -  "get_fama_and_french_model",
      -  "get_fama_decomposition",
      -  "get_gain_to_pain_ratio",
      -  "get_henriksson_merton_model",
      -  "get_information_ratio",
      -  "get_jensens_alpha",
      -  "get_kappa_ratio",
      -  "get_kelly_criterion",
      -  "get_m2_ratio",
      -  "get_morningstar_risk",
      -  "get_morningstar_risk_adjusted_return",
      -  "get_omega_ratio",
      -  "get_rachev_ratio",
      -  "get_return_statistics",
      -  "get_returns",
      -  "get_sharpe_ratio",
      -  "get_sortino_ratio",
      -  "get_starr_ratio",
      -  "get_sterling_ratio",
      -  "get_style_analysis",
      -  "get_tracking_error",
      -  "get_treynor_mazuy_model",
      -  "get_treynor_ratio",
      -  "get_ulcer_performance_index",
      -  "get_upside_capture_ratio",
      -  "get_win_rate"
      -]New value: +[
      +  "get_alpha",
      +  "get_appraisal_ratio",
      +  "get_beta",
      +  "get_beta_implied_return",
      +  "get_burke_ratio",
      +  "get_calmar_ratio",
      +  "get_capital_asset_pricing_model",
      +  "get_carhart_four_factor_model",
      +  "get_cokurtosis",
      +  "get_compound_growth_rate",
      +  "get_correlation_matrix",
      +  "get_coskewness",
      +  "get_covariance_matrix",
      +  "get_downside_capture_ratio",
      +  "get_excess_return",
      +  "get_factor_analysis",
      +  "get_factor_asset_correlations",
      +  "get_factor_correlations",
      +  "get_fama_and_french_model",
      +  "get_fama_decomposition",
      +  "get_gain_to_pain_ratio",
      +  "get_henriksson_merton_model",
      +  "get_information_ratio",
      +  "get_jensens_alpha",
      +  "get_kappa_ratio",
      +  "get_kelly_criterion",
      +  "get_m2_ratio",
      +  "get_minimum_track_record_length",
      +  "get_morningstar_risk",
      +  "get_morningstar_risk_adjusted_return",
      +  "get_omega_ratio",
      +  "get_rachev_ratio",
      +  "get_return_statistics",
      +  "get_returns",
      +  "get_sharpe_ratio",
      +  "get_sharpe_ratio_standard_error",
      +  "get_sortino_ratio",
      +  "get_starr_ratio",
      +  "get_sterling_ratio",
      +  "get_style_analysis",
      +  "get_tracking_error",
      +  "get_treynor_mazuy_model",
      +  "get_treynor_ratio",
      +  "get_ulcer_performance_index",
      +  "get_upside_capture_ratio",
      +  "get_win_rate"
      +]
    • addedInput schema / properties / lags / anyOf
      Added value: +[
      +  {
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / lags / default
      Previous value: -1New value: +null
    • changedInput schema / properties / lags / description
      Previous value: -"The number of lags (past periods) the test or model uses, e.g. 1 or 5."New value: +"The number of lags (past periods) the test or model uses, e.g. 1 or 5. Leave unset to use the default of the indicator you selected. Defaults are None for get_sharpe_ratio, get_sharpe_ratio_standard_error; 1 for get_beta."
    • removedInput schema / properties / lags / type
      Removed value: -"integer"
    • changedInput schema / properties / method / description
      Previous value: -"The regression method to use for the calculation. Leave unset to use the default of the indicator you selected. Defaults are 'discrete' for get_kelly_criterion; 'multi' for get_fama_and_french_model; 'ols' for get_beta; 'standard' for get_sharpe_ratio."New value: +"\"standardized\" or \"residual\". Leave unset to use the default of the indicator you selected. Defaults are 'standardized' for get_cokurtosis, get_coskewness; 'discrete' for get_kelly_criterion; 'iid' for get_sharpe_ratio_standard_error; 'multi' for get_fama_and_french_model; 'ols' for get_beta; 'standard' for get_sharpe_ratio."
    • removedInput schema / properties / metrics / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • changedInput schema / properties / metrics / default
      Previous value: -nullNew value: +"all"
    • changedInput schema / properties / metrics / description
      Previous value: -"get_factor_analysis only: the metric(s) to analyse, a method name such as 'get_price_to_earnings_ratio', a comma-separated list, or a collection of the tool (see the tool description), e.g. 'profitability'. Leave unset to use the default of the indicator you selected. Required by: get_factor_analysis."New value: +"get_factor_analysis only: the metric(s) to analyse, a method name such as 'get_price_to_earnings_ratio', a comma-separated list, or a collection of the tool (see the tool description), e.g. 'profitability'."
    • addedInput schema / properties / metrics / type
      Added value: +"string"
    • addedInput schema / properties / risk_free_rate
      Added value: +{
      +  "default": "10y",
      +  "description": "The US Treasury yield used as the risk-free rate: '13w' (the 13-week bill), '5y', '10y' (default) or '30y'.",
      +  "enum": [
      +    "13w",
      +    "5y",
      +    "10y",
      +    "30y"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / style_tickers / description
      Previous value: -"The tickers of the style indices, as a list or a comma-separated string. Leave unset to use the default of the indicator you selected. Required by: get_style_analysis."New value: +"The tickers of the style indices, as a list or a comma-separated string."
  3. Changed18 schema fields changedv2.3.2
    • addedInput schema / properties / beta_window
      Added value: +{
      +  "default": 252,
      +  "description": "The number of daily returns the Beta is estimated on.",
      +  "type": "integer"
      +}
    • addedInput schema / properties / column
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The price column to use, e.g. 'Close' or 'Adj Close'; for get_factor_analysis the output of a metric with several, e.g. 'Signal Line'."
      +}
    • addedInput schema / properties / detail
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "get_factor_analysis only: 'information_coefficient', 'quantile_returns', 'quantile_turnover' or 'rank_autocorrelation' returns that part for a single metric instead of the summary."
      +}
    • addedInput schema / properties / fraction
      Added value: +{
      +  "default": 1,
      +  "description": "The share of the full Kelly bet, e.g. 0.5 for half Kelly.",
      +  "type": "number"
      +}
    • addedInput schema / properties / gamma
      Added value: +{
      +  "default": 2,
      +  "description": "The risk aversion, 0 or higher.",
      +  "type": "number"
      +}
    • addedInput schema / properties / horizons
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "items": {
      +        "type": "integer"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The number of periods the forward returns cover."
      +}
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_alpha",
      -  "get_appraisal_ratio",
      -  "get_beta",
      -  "get_burke_ratio",
      -  "get_calmar_ratio",
      -  "get_capital_asset_pricing_model",
      -  "get_carhart_four_factor_model",
      -  "get_compound_growth_rate",
      -  "get_correlation_matrix",
      -  "get_covariance_matrix",
      -  "get_downside_capture_ratio",
      -  "get_excess_return",
      -  "get_factor_asset_correlations",
      -  "get_factor_correlations",
      -  "get_fama_and_french_model",
      -  "get_fama_decomposition",
      -  "get_gain_to_pain_ratio",
      -  "get_henriksson_merton_model",
      -  "get_information_ratio",
      -  "get_jensens_alpha",
      -  "get_kappa_ratio",
      -  "get_m2_ratio",
      -  "get_omega_ratio",
      -  "get_rachev_ratio",
      -  "get_returns",
      -  "get_sharpe_ratio",
      -  "get_sortino_ratio",
      -  "get_starr_ratio",
      -  "get_sterling_ratio",
      -  "get_style_analysis",
      -  "get_tracking_error",
      -  "get_treynor_mazuy_model",
      -  "get_treynor_ratio",
      -  "get_ulcer_performance_index",
      -  "get_upside_capture_ratio",
      -  "get_win_rate"
      -]New value: +[
      +  "get_alpha",
      +  "get_appraisal_ratio",
      +  "get_beta",
      +  "get_beta_implied_return",
      +  "get_burke_ratio",
      +  "get_calmar_ratio",
      +  "get_capital_asset_pricing_model",
      +  "get_carhart_four_factor_model",
      +  "get_compound_growth_rate",
      +  "get_correlation_matrix",
      +  "get_covariance_matrix",
      +  "get_downside_capture_ratio",
      +  "get_excess_return",
      +  "get_factor_analysis",
      +  "get_factor_asset_correlations",
      +  "get_factor_correlations",
      +  "get_fama_and_french_model",
      +  "get_fama_decomposition",
      +  "get_gain_to_pain_ratio",
      +  "get_henriksson_merton_model",
      +  "get_information_ratio",
      +  "get_jensens_alpha",
      +  "get_kappa_ratio",
      +  "get_kelly_criterion",
      +  "get_m2_ratio",
      +  "get_morningstar_risk",
      +  "get_morningstar_risk_adjusted_return",
      +  "get_omega_ratio",
      +  "get_rachev_ratio",
      +  "get_return_statistics",
      +  "get_returns",
      +  "get_sharpe_ratio",
      +  "get_sortino_ratio",
      +  "get_starr_ratio",
      +  "get_sterling_ratio",
      +  "get_style_analysis",
      +  "get_tracking_error",
      +  "get_treynor_mazuy_model",
      +  "get_treynor_ratio",
      +  "get_ulcer_performance_index",
      +  "get_upside_capture_ratio",
      +  "get_win_rate"
      +]
    • addedInput schema / properties / lags
      Added value: +{
      +  "default": 1,
      +  "description": "The number of lags (past periods) the test or model uses, e.g. 1 or 5.",
      +  "type": "integer"
      +}
    • changedInput schema / properties / limit / description
      Previous value: -"The rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length. 0 returns every row."New value: +"The rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead, and rows per ticker (an earnings calendar) are selected per ticker. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length. 0 returns every row."
    • changedInput schema / properties / method / description
      Previous value: -"For get_fama_and_french_model: The regression method to use for the calculation. For get_sharpe_ratio: Which Sharpe ratio to calculate, one of \"standard\", \"adjusted\", \"probabilistic\" or \"deflated\". Leave unset to use the default of the indicator you selected. Defaults are 'multi' for get_fama_and_french_model; 'standard' for get_sharpe_ratio."New value: +"The regression method to use for the calculation. Leave unset to use the default of the indicator you selected. Defaults are 'discrete' for get_kelly_criterion; 'multi' for get_fama_and_french_model; 'ols' for get_beta; 'standard' for get_sharpe_ratio."
    • addedInput schema / properties / metrics
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "get_factor_analysis only: the metric(s) to analyse, a method name such as 'get_price_to_earnings_ratio', a comma-separated list, or a collection of the tool (see the tool description), e.g. 'profitability'. Leave unset to use the default of the indicator you selected. Required by: get_factor_analysis."
      +}
    • addedInput schema / properties / periods_apart
      Added value: +{
      +  "default": 1,
      +  "description": "The number of periods between the dates the quantile turnover and the rank autocorrelation compare.",
      +  "type": "integer"
      +}
    • addedInput schema / properties / quantiles
      Added value: +{
      +  "default": 5,
      +  "description": "The number of quantiles the tickers are sorted into per period.",
      +  "type": "integer"
      +}
    • changedInput schema / properties / rolling / description
      Previous value: -"Rolling window size in number of periods. When set, the metric is computed over a smoothly overlapping trailing window across the full history (e.g. period='monthly' and rolling=6 gives a rolling 6-month value) instead of one value per period, or (for economics indicators) a simple moving average used to smooth the raw series. Leave unset to use the default of the indicator you selected. Defaults are None for get_alpha, get_appraisal_ratio, get_beta, get_capital_asset_pricing_model, get_fama_decomposition, get_information_ratio, get_jensens_alpha, get_m2_ratio, get_omega_ratio, get_sharpe_ratio, get_sortino_ratio, get_tracking_error, get_treynor_ratio; 14 for get_ulcer_performance_index."New value: +"Rolling window size in number of periods. When set, the metric is computed over a smoothly overlapping trailing window across the full history (e.g. period='monthly' and rolling=6 gives a rolling 6-month value) instead of one value per period, or (for economics indicators) a simple moving average used to smooth the raw series. Leave unset to use the default of the indicator you selected. Defaults differ between indicators."
    • addedInput schema / properties / within_period / anyOf
      Added value: +[
      +  {
      +    "type": "boolean"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / within_period / default
      Previous value: -trueNew value: +null
    • changedInput schema / properties / within_period / description
      Previous value: -"Whether to calculate the CVaR within the specified period or for the entire period. Thus whether to look at the CVaR within a specific year (if period = 'yearly') or look at the entirety of all years."New value: +"Whether to calculate the risk of the months within each period or of all months in the range. Leave unset to use the default of the indicator you selected. Defaults are True for get_burke_ratio, get_calmar_ratio, get_gain_to_pain_ratio, get_kelly_criterion, get_morningstar_risk, get_morningstar_risk_adjusted_return, get_omega_ratio, get_rachev_ratio, get_starr_ratio, get_sterling_ratio; False for get_return_statistics."
    • removedInput schema / properties / within_period / type
      Removed value: -"boolean"
  4. Changed6 schema fields changedv2.3.1
    • changedInput schema / properties / benchmark_ticker / description
      Previous value: -"Ticker used as the market benchmark, e.g. 'SPY' or '^GSPC'."New value: +"Ticker used as the market benchmark, e.g. 'SPY' or '^GSPC'; 'None' for no benchmark."
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-10-27"New value: +""
    • changedInput schema / properties / end_date / description
      Previous value: -"End of the date range in YYYY-MM-DD format."New value: +"End of the date range in YYYY-MM-DD format; left empty, today (or the indicator's own window)."
    • changedInput schema / properties / limit / description
      Previous value: -"The rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length."New value: +"The rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length. 0 returns every row."
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-10-28"New value: +""
    • changedInput schema / properties / start_date / description
      Previous value: -"Start of the date range in YYYY-MM-DD format."New value: +"Start of the date range in YYYY-MM-DD format; left empty, five years before today (or the indicator's own window)."
  5. Changed8 schema fields changedv2.3.0
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-10-14"New value: +"2026-10-27"
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_alpha",
      -  "get_appraisal_ratio",
      -  "get_beta",
      -  "get_burke_ratio",
      -  "get_calmar_ratio",
      -  "get_capital_asset_pricing_model",
      -  "get_carhart_four_factor_model",
      -  "get_compound_growth_rate",
      -  "get_correlation_matrix",
      -  "get_covariance_matrix",
      -  "get_downside_capture_ratio",
      -  "get_excess_return",
      -  "get_factor_asset_correlations",
      -  "get_factor_correlations",
      -  "get_fama_and_french_model",
      -  "get_fama_decomposition",
      -  "get_gain_to_pain_ratio",
      -  "get_henriksson_merton_model",
      -  "get_information_ratio",
      -  "get_jensens_alpha",
      -  "get_kappa_ratio",
      -  "get_m2_ratio",
      -  "get_omega_ratio",
      -  "get_rachev_ratio",
      -  "get_returns",
      -  "get_sharpe_ratio",
      -  "get_sortino_ratio",
      -  "get_starr_ratio",
      -  "get_sterling_ratio",
      -  "get_tracking_error",
      -  "get_treynor_mazuy_model",
      -  "get_treynor_ratio",
      -  "get_ulcer_performance_index",
      -  "get_upside_capture_ratio",
      -  "get_win_rate"
      -]New value: +[
      +  "get_alpha",
      +  "get_appraisal_ratio",
      +  "get_beta",
      +  "get_burke_ratio",
      +  "get_calmar_ratio",
      +  "get_capital_asset_pricing_model",
      +  "get_carhart_four_factor_model",
      +  "get_compound_growth_rate",
      +  "get_correlation_matrix",
      +  "get_covariance_matrix",
      +  "get_downside_capture_ratio",
      +  "get_excess_return",
      +  "get_factor_asset_correlations",
      +  "get_factor_correlations",
      +  "get_fama_and_french_model",
      +  "get_fama_decomposition",
      +  "get_gain_to_pain_ratio",
      +  "get_henriksson_merton_model",
      +  "get_information_ratio",
      +  "get_jensens_alpha",
      +  "get_kappa_ratio",
      +  "get_m2_ratio",
      +  "get_omega_ratio",
      +  "get_rachev_ratio",
      +  "get_returns",
      +  "get_sharpe_ratio",
      +  "get_sortino_ratio",
      +  "get_starr_ratio",
      +  "get_sterling_ratio",
      +  "get_style_analysis",
      +  "get_tracking_error",
      +  "get_treynor_mazuy_model",
      +  "get_treynor_ratio",
      +  "get_ulcer_performance_index",
      +  "get_upside_capture_ratio",
      +  "get_win_rate"
      +]
    • changedInput schema / properties / period / description
      Previous value: -"Observation frequency, e.g. 'daily', 'weekly', 'monthly', 'quarterly', or 'annual' (supported values differ per method)."New value: +"Observation frequency, e.g. 'daily', 'weekly', 'monthly', 'quarterly', or 'annual' (supported values differ per method). Leave unset to use the default of the indicator you selected. Defaults differ between indicators."
    • addedInput schema / properties / region
      Added value: +{
      +  "default": "United States",
      +  "description": "The region whose factors to use: \"United States\", \"Developed\", \"Developed ex US\", \"Europe\", \"Japan\", \"Asia Pacific ex Japan\" or \"North America\" (the factors of Ken French's library for that region's stocks). Every region's factors are U.S. dollar returns with the U.S. one-month Treasury bill as...",
      +  "type": "string"
      +}
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-10-15"New value: +"2021-10-28"
    • addedInput schema / properties / style_tickers
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The tickers of the style indices, as a list or a comma-separated string. Leave unset to use the default of the indicator you selected. Required by: get_style_analysis."
      +}
    • changedInput schema / properties / trials_window / description
      Previous value: -"The window size (in units of `period`) used for the auxiliary rolling Sharpe ratio series that approximates `Var[SR_trials]` and the default `n_trials`. Only used when method=\"deflated\"."New value: +"The window size of the auxiliary rolling Sharpe ratio series that approximates `Var[SR_trials]` and the default `n_trials`. Only used when method=\"deflated\". It counts observations of the returns the Sharpe ratio is computed from: daily (or intraday) observations for the Sharpe ratio per period,..."
    • addedInput schema / properties / window
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The number of periods the indicator looks back over, e.g. 14 or 20."
      +}
  6. Changed48 schema fields changedv2.2.3
    • changedInput schema / properties / adjustment / description
      Previous value: -"Value for adjustment."New value: +"The fixed adjustment added to the Average Drawdown, conventionally 0.1 (10%)."
    • removedInput schema / properties / adjustment / title
      Removed value: -"Adjustment"
    • changedInput schema / properties / alpha / description
      Previous value: -"Value for alpha."New value: +"For get_rachev_ratio: The confidence level used for both tails (e.g. 0.05 for the best/worst 5% of outcomes). For get_starr_ratio: The confidence level used for the CVaR calculation (e.g. 0.05 for the worst 5% of outcomes)."
    • removedInput schema / properties / alpha / title
      Removed value: -"Alpha"
    • addedInput schema / properties / annualize
      Added value: +{
      +  "default": false,
      +  "description": "Set to true to annualize a Sharpe ratio (by default it is per observation, e.g. per day, so roughly sqrt(252) smaller than the annualized figure).",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / benchmark_sharpe_ratio / description
      Previous value: -"Value for benchmark_sharpe_ratio."New value: +"The hypothesized or benchmark Sharpe ratio (SR*) to test the observed Sharpe ratio against. Only used when method=\"probabilistic\"."
    • removedInput schema / properties / benchmark_sharpe_ratio / title
      Removed value: -"Benchmark Sharpe Ratio"
    • removedInput schema / properties / benchmark_ticker / title
      Removed value: -"Benchmark Ticker"
    • removedInput schema / properties / cumulative / title
      Removed value: -"Cumulative"
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-10-02"New value: +"2026-10-14"
    • removedInput schema / properties / end_date / title
      Removed value: -"End Date"
    • changedInput schema / properties / exclude_risk_free / description
      Previous value: -"Value for exclude_risk_free."New value: +"Whether to exclude the risk-free rate from the results."
    • removedInput schema / properties / exclude_risk_free / title
      Removed value: -"Exclude Risk Free"
    • removedInput schema / properties / factors_to_calculate / title
      Removed value: -"Factors To Calculate"
    • removedInput schema / properties / growth / title
      Removed value: -"Growth"
    • changedInput schema / properties / include_daily_residuals / description
      Previous value: -"Value for include_daily_residuals."New value: +"Whether to also return the pointwise (daily) regression residuals as a second DataFrame."
    • removedInput schema / properties / include_daily_residuals / title
      Removed value: -"Include Daily Residuals"
    • changedInput schema / properties / indicator / description
      Previous value: -"Name of the specific metric to calculate, e.g. 'get_asset_turnover_ratio'. Required — omitting it returns the list of available indicators."New value: +"Name of the specific metric to calculate, one of the listed values. Required — search_metrics finds the indicator (and its tool) for a metric by name."
    • removedInput schema / properties / indicator / title
      Removed value: -"Indicator"
    • addedInput schema / properties / lag / anyOf
      Added value: +[
      +  {
      +    "type": "integer"
      +  },
      +  {
      +    "items": {
      +      "type": "integer"
      +    },
      +    "type": "array"
      +  }
      +]
    • removedInput schema / properties / lag / title
      Removed value: -"Lag"
    • removedInput schema / properties / lag / type
      Removed value: -"integer"
    • addedInput schema / properties / limit
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length."
      +}
    • changedInput schema / properties / method / description
      Previous value: -"Value for method. Leave unset to use the default of the indicator you selected. Defaults are 'multi' for get_fama_and_french_model; 'standard' for get_sharpe_ratio."New value: +"For get_fama_and_french_model: The regression method to use for the calculation. For get_sharpe_ratio: Which Sharpe ratio to calculate, one of \"standard\", \"adjusted\", \"probabilistic\" or \"deflated\". Leave unset to use the default of the indicator you selected. Defaults are 'multi' for get_fama_and_french_model; 'standard' for get_sharpe_ratio."
    • removedInput schema / properties / method / title
      Removed value: -"Method"
    • removedInput schema / properties / minimum_acceptable_return / title
      Removed value: -"Minimum Acceptable Return"
    • changedInput schema / properties / n_trials / description
      Previous value: -"Value for n_trials."New value: +"The number of independent (or effectively independent) strategy variations, parameter combinations, or lookback windows tried before arriving at the reported Sharpe ratio. Only used when method=\"deflated\". Pass this explicitly whenever the actual number of trials is known."
    • removedInput schema / properties / n_trials / title
      Removed value: -"N Trials"
    • changedInput schema / properties / order / description
      Previous value: -"Value for order."New value: +"The order of the lower partial moment used in the denominator."
    • removedInput schema / properties / order / title
      Removed value: -"Order"
    • changedInput schema / properties / period / description
      Previous value: -"Observation frequency, e.g. 'monthly', 'quarterly', or 'annual'."New value: +"Observation frequency, e.g. 'daily', 'weekly', 'monthly', 'quarterly', or 'annual' (supported values differ per method)."
    • removedInput schema / properties / period / title
      Removed value: -"Period"
    • removedInput schema / properties / quarterly / title
      Removed value: -"Quarterly"
    • removedInput schema / properties / rolling / title
      Removed value: -"Rolling"
    • removedInput schema / properties / show_columns / title
      Removed value: -"Show Columns"
    • changedInput schema / properties / show_full_results / description
      Previous value: -"Value for show_full_results."New value: +"Whether to show the actual and benchmark returns next to the Alpha."
    • removedInput schema / properties / show_full_results / title
      Removed value: -"Show Full Results"
    • removedInput schema / properties / standardize / title
      Removed value: -"Standardize"
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-10-03"New value: +"2021-10-15"
    • removedInput schema / properties / start_date / title
      Removed value: -"Start Date"
    • addedInput schema / properties / tickers / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "items": {
      +      "type": "string"
      +    },
      +    "type": "array"
      +  }
      +]
    • removedInput schema / properties / tickers / title
      Removed value: -"Tickers"
    • removedInput schema / properties / tickers / type
      Removed value: -"string"
    • changedInput schema / properties / trials_window / description
      Previous value: -"Value for trials_window."New value: +"The window size (in units of `period`) used for the auxiliary rolling Sharpe ratio series that approximates `Var[SR_trials]` and the default `n_trials`. Only used when method=\"deflated\"."
    • removedInput schema / properties / trials_window / title
      Removed value: -"Trials Window"
    • changedInput schema / properties / within_period / description
      Previous value: -"Value for within_period."New value: +"Whether to calculate the CVaR within the specified period or for the entire period. Thus whether to look at the CVaR within a specific year (if period = 'yearly') or look at the entirety of all years."
    • removedInput schema / properties / within_period / title
      Removed value: -"Within Period"
    • removedInput schema / title
      Removed value: -"performanceArguments"
  7. Changed2 schema fields changedv2.2.1
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-08-19"New value: +"2026-10-02"
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-08-20"New value: +"2021-10-03"
  8. Changed12 schema fields changedv2.2.0
    • addedInput schema / properties / alpha
      Added value: +{
      +  "default": 0.05,
      +  "description": "Value for alpha.",
      +  "title": "Alpha",
      +  "type": "number"
      +}
    • addedInput schema / properties / benchmark_sharpe_ratio
      Added value: +{
      +  "default": 0,
      +  "description": "Value for benchmark_sharpe_ratio.",
      +  "title": "Benchmark Sharpe Ratio",
      +  "type": "number"
      +}
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-07-14"New value: +"2026-08-19"
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_alpha",
      -  "get_beta",
      -  "get_burke_ratio",
      -  "get_calmar_ratio",
      -  "get_capital_asset_pricing_model",
      -  "get_compound_growth_rate",
      -  "get_correlation_matrix",
      -  "get_covariance_matrix",
      -  "get_downside_capture_ratio",
      -  "get_excess_return",
      -  "get_factor_asset_correlations",
      -  "get_factor_correlations",
      -  "get_fama_and_french_model",
      -  "get_gain_to_pain_ratio",
      -  "get_information_ratio",
      -  "get_jensens_alpha",
      -  "get_kappa_ratio",
      -  "get_m2_ratio",
      -  "get_omega_ratio",
      -  "get_returns",
      -  "get_sharpe_ratio",
      -  "get_sortino_ratio",
      -  "get_sterling_ratio",
      -  "get_tracking_error",
      -  "get_treynor_ratio",
      -  "get_ulcer_performance_index",
      -  "get_upside_capture_ratio",
      -  "get_win_rate"
      -]New value: +[
      +  "get_alpha",
      +  "get_appraisal_ratio",
      +  "get_beta",
      +  "get_burke_ratio",
      +  "get_calmar_ratio",
      +  "get_capital_asset_pricing_model",
      +  "get_carhart_four_factor_model",
      +  "get_compound_growth_rate",
      +  "get_correlation_matrix",
      +  "get_covariance_matrix",
      +  "get_downside_capture_ratio",
      +  "get_excess_return",
      +  "get_factor_asset_correlations",
      +  "get_factor_correlations",
      +  "get_fama_and_french_model",
      +  "get_fama_decomposition",
      +  "get_gain_to_pain_ratio",
      +  "get_henriksson_merton_model",
      +  "get_information_ratio",
      +  "get_jensens_alpha",
      +  "get_kappa_ratio",
      +  "get_m2_ratio",
      +  "get_omega_ratio",
      +  "get_rachev_ratio",
      +  "get_returns",
      +  "get_sharpe_ratio",
      +  "get_sortino_ratio",
      +  "get_starr_ratio",
      +  "get_sterling_ratio",
      +  "get_tracking_error",
      +  "get_treynor_mazuy_model",
      +  "get_treynor_ratio",
      +  "get_ulcer_performance_index",
      +  "get_upside_capture_ratio",
      +  "get_win_rate"
      +]
    • addedInput schema / properties / method / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / method / default
      Previous value: -"multi"New value: +null
    • changedInput schema / properties / method / description
      Previous value: -"Value for method."New value: +"Value for method. Leave unset to use the default of the indicator you selected. Defaults are 'multi' for get_fama_and_french_model; 'standard' for get_sharpe_ratio."
    • removedInput schema / properties / method / type
      Removed value: -"string"
    • addedInput schema / properties / n_trials
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Value for n_trials.",
      +  "title": "N Trials"
      +}
    • changedInput schema / properties / rolling / description
      Previous value: -"Rolling window size in number of periods. When set, the metric is computed over a smoothly overlapping trailing window across the full history (e.g. period='monthly' and rolling=6 gives a rolling 6-month value) instead of one value per period, or (for economics indicators) a simple moving average used to smooth the raw series."New value: +"Rolling window size in number of periods. When set, the metric is computed over a smoothly overlapping trailing window across the full history (e.g. period='monthly' and rolling=6 gives a rolling 6-month value) instead of one value per period, or (for economics indicators) a simple moving average used to smooth the raw series. Leave unset to use the default of the indicator you selected. Defaults are None for get_alpha, get_appraisal_ratio, get_beta, get_capital_asset_pricing_model, get_fama_decomposition, get_information_ratio, get_jensens_alpha, get_m2_ratio, get_omega_ratio, get_sharpe_ratio, get_sortino_ratio, get_tracking_error, get_treynor_ratio; 14 for get_ulcer_performance_index."
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-07-15"New value: +"2021-08-20"
    • addedInput schema / properties / trials_window
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Value for trials_window.",
      +  "title": "Trials Window"
      +}
  9. Changed10 schema fields changed
    • addedInput schema / properties / adjustment
      Added value: +{
      +  "default": 0.1,
      +  "description": "Value for adjustment.",
      +  "title": "Adjustment",
      +  "type": "number"
      +}
    • addedInput schema / properties / cumulative
      Added value: +{
      +  "default": false,
      +  "description": "Return the cumulative value compounded over time instead of the discrete value per period. Always rebased to start at 1 at the beginning of the selected date range.",
      +  "title": "Cumulative",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-07-09"New value: +"2026-07-14"
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_alpha",
      -  "get_beta",
      -  "get_capital_asset_pricing_model",
      -  "get_compound_growth_rate",
      -  "get_factor_asset_correlations",
      -  "get_factor_correlations",
      -  "get_fama_and_french_model",
      -  "get_information_ratio",
      -  "get_jensens_alpha",
      -  "get_m2_ratio",
      -  "get_sharpe_ratio",
      -  "get_sortino_ratio",
      -  "get_tracking_error",
      -  "get_treynor_ratio",
      -  "get_ulcer_performance_index"
      -]New value: +[
      +  "get_alpha",
      +  "get_beta",
      +  "get_burke_ratio",
      +  "get_calmar_ratio",
      +  "get_capital_asset_pricing_model",
      +  "get_compound_growth_rate",
      +  "get_correlation_matrix",
      +  "get_covariance_matrix",
      +  "get_downside_capture_ratio",
      +  "get_excess_return",
      +  "get_factor_asset_correlations",
      +  "get_factor_correlations",
      +  "get_fama_and_french_model",
      +  "get_gain_to_pain_ratio",
      +  "get_information_ratio",
      +  "get_jensens_alpha",
      +  "get_kappa_ratio",
      +  "get_m2_ratio",
      +  "get_omega_ratio",
      +  "get_returns",
      +  "get_sharpe_ratio",
      +  "get_sortino_ratio",
      +  "get_sterling_ratio",
      +  "get_tracking_error",
      +  "get_treynor_ratio",
      +  "get_ulcer_performance_index",
      +  "get_upside_capture_ratio",
      +  "get_win_rate"
      +]
    • addedInput schema / properties / minimum_acceptable_return
      Added value: +{
      +  "default": 0,
      +  "description": "The minimum acceptable return (MAR) threshold below which returns are considered downside, e.g. 0.0 for downside relative to a zero return.",
      +  "title": "Minimum Acceptable Return",
      +  "type": "number"
      +}
    • addedInput schema / properties / order
      Added value: +{
      +  "default": 3,
      +  "description": "Value for order.",
      +  "title": "Order",
      +  "type": "integer"
      +}
    • changedInput schema / properties / rolling / description
      Previous value: -"Value for rolling."New value: +"Rolling window size in number of periods. When set, the metric is computed over a smoothly overlapping trailing window across the full history (e.g. period='monthly' and rolling=6 gives a rolling 6-month value) instead of one value per period, or (for economics indicators) a simple moving average used to smooth the raw series."
    • addedInput schema / properties / standardize
      Added value: +{
      +  "default": false,
      +  "description": "Return the Z-Score (standard score) instead of the raw values, i.e. how many standard deviations each value is from the mean of its own series. When combined with growth=True, the growth values are standardized instead of the raw values.",
      +  "title": "Standardize",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-07-10"New value: +"2021-07-15"
    • addedInput schema / properties / within_period
      Added value: +{
      +  "default": true,
      +  "description": "Value for within_period.",
      +  "title": "Within Period",
      +  "type": "boolean"
      +}
  10. Changed2 schema fields changedv2.1.4
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-06-27"New value: +"2026-07-09"
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-06-28"New value: +"2021-07-10"
  11. Changed2 schema fields changedv2.1.3
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-06-23"New value: +"2026-06-27"
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-06-24"New value: +"2021-06-28"
  12. Changed4 schema fields changedv0.1.2
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-06-22"New value: +"2026-06-23"
    • removedInput schema / properties / rounding
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "integer"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "description": "Number of decimal places to round results to.",
      -  "title": "Rounding"
      -}
    • addedInput schema / properties / show_columns
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Comma-separated names to filter the output. For historical data use the key names visible in any response record (e.g. 'Close,Volume,Return'). For financial statements use the 'metric' field values from the response (e.g. 'Revenue,Net Income,EBITDA'). Call the tool once without this parameter to see all available names, then repeat with show_columns to reduce response size and token usage.",
      +  "title": "Show Columns"
      +}
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-06-23"New value: +"2021-06-24"
  13. Addedv0.1.1

TDQS

A3.9/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already mark it read-only, idempotent, and open-world; the description adds substantial behavioral detail: per-observation vs annualized Sharpe, rolling windows, method-specific defaults, empty-result conditions, and date-range nuances. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single dense paragraph with nested parentheticals and many indicator-specific details; it is not front-loaded beyond the opening list and is hard to scan. Given the tool's complexity some length is warranted, but structure and concision are poor.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 44-parameter multi-indicator tool with an output schema and read-only annotations, the description covers the key behavioral and parameter interactions needed to call it correctly. It is complete enough, even if sibling routing is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning for many parameters: method values for beta/Sharpe, rolling behavior, cumulative rebasing, beta_window, and start_date semantics. It does not explain every one of the 44 parameters, but it adds significant value beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States that the tool returns pre-computed risk-adjusted performance metrics and enumerates the indicators (Sharpe, Sortino, Beta, CAPM, etc.), so the resource is clear. It does not explicitly differentiate from sibling tools such as risk or portfolio_performance, so it is not a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives extensive indicator-specific conditions (e.g. Lo Sharpe needs 30+ returns, daily only with rolling), but it never states when to choose this tool over sibling tools like risk or portfolio_performance. Usage is implied by the metric list rather than explicitly routed.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.