Skip to main content
Glama

Valuein — SEC EDGAR Fundamentals & Smart-Money Data

Financial Ratios

get_financial_ratios
Read-onlyIdempotent

Get pipeline-computed financial ratios from ratio.parquet. Served categories: profitability (margins, ROE, ROA, ROIC), liquidity (current ratio, quick ratio), leverage (D/E, interest coverage, net debt/EBITDA), efficiency (asset turnover, inventory days), per_share (EPS, BVPS, FCF/share), owner_earnings (Buffett FCF, owner yield), valuation (pe_ratio, pb_ratio, ev_ebitda, market_cap, dividend_yield), and the pipeline-emitted forensic, growth, and rank (cross-sectional *_sector_pctile) categories. NOT every category exists for every ticker — omit categories to get whatever this ticker has, or read available_categories on the DATA_NOT_AVAILABLE_FOR_PERIOD error a missing category returns. valuation is LIVE (schema 2.18.0): price-derived multiples from EOD prices period-end-aligned — pipeline-derived, NOT strictly PIT (no accepted_at column on these rows). Includes TTM rows alongside annual; each row's is_calendar_aligned is TRUE only when period_end sits on the fiscal-year boundary (±7 days) — filter to TRUE when joining ratios to fact-table fundamentals on (entity, fiscal_year). For historical cuts use as_of_date (PIT by accepted_at when present, else by period_end — see the param). Use this instead of get_valuation_metrics when you only need ratios (no DCF wiring); use get_valuation_metrics when you also need DCF/DDM. Each ratio is a {value, unit, category, reason} entry with a response-level lineage (DerivedLineage) pointing to get_company_fundamentals / verify_fact_lineage for filing-level provenance; a null value carries a reason (e.g. INPUT_MISSING) so missing is never a real zero. An FY ratio also carries a derived_id: cite it like a fact_id (verify_facts re-reads the row). On fiscal-year rows net_debt (total_debt − (cash + short-term investments), the compute_dcf definition), fcf_margin, debt_to_equity (total_debt / equity) and the *_cagr_Ny ratios are recomputed from the annual facts (basis: recomputed_from_facts) so every tool agrees; those carry a formula-form derived_id over the input facts when a registered formula reproduces the figure (net_debt carries none); a CAGR over a zero or negative base is null with a reason. Available on all plans.

Input Schema

NameRequiredDescriptionDefault
limitNoNumber of distinct period_end dates to return (1–20). Defaults to 5. Within each period, all matching ratio_names are included.
tickerYesStock ticker symbol, e.g. AAPL, MSFT — or a CIK (SEC identifier), e.g. '0000320193'.
as_of_dateNoHistorical cutoff (canonical cross-tool date param). PIT by SEC accepted_at when the ratio data carries it (latest value knowable on/before the date, zero look-ahead, _meta.pit_safe=true), else by ratio.period_end (pit_safe=false). For guaranteed accepted_at PIT use get_company_fundamentals.
categoriesNoRatio categories to include (see the enum). Omit to return every category this ticker has. `valuation` (pe_ratio, pb_ratio, ev_ebitda, market_cap, dividend_yield) is LIVE since schema 2.18.0 — price-derived, period-end-aligned, not strictly PIT. Availability is per-ticker (the envelope lists this ticker's available_categories).
fiscal_periodNoFilter to a specific fiscal period type. Use 'TTM' for trailing twelve months. Omit to return both annual (FY) and TTM rows.
period_end_beforeNoAlias of as_of_date (as_of_date preferred — the canonical name). Returns ratios with period_end on or before this date.

Output Schema

NameRequiredDescriptionDefault
dataYes
noteYes
planYes
_metaYesProvenance envelope — data lineage for every MCP response
tickerYes
lineageNoProvenance for pipeline-derived values (ratio.parquet / factor_scores.parquet): source table + pipeline computed_at, plus a pointer to the tools that return filing-level lineage. NOT point-in-time (recomputed on each pipeline run).
periods_returnedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / _meta / properties / cost_usd / properties / basis / description
      Previous value: -"payg_charge = real charge (agent-pay or your balance). payg_rate_card = indicative price, not billed."New value: +"payg_charge = real pay-per-call charge (a card or MPP payment through agent-pay). payg_rate_card = indicative price, not billed."
  2. Changed2 schema fields changed
    • changedOutput schema / properties / _meta / properties / cost_usd / properties / basis / description
      Previous value: -"payg_charge = real agent-pay charge. payg_rate_card = indicative price, not billed."New value: +"payg_charge = real charge (agent-pay or your balance). payg_rate_card = indicative price, not billed."
    • changedOutput schema / properties / _meta / properties / cost_usd / properties / billed / description
      Previous value: -"true = this amount was actually charged via PAYG for this call. false = indicative PAYG-equivalent value; your plan already covers this call for free."New value: +"true = this amount was actually charged via PAYG for this call. false = indicative PAYG-equivalent value only: no charge was made for this call (it was within your plan)."
  3. Changed2 schema fields changed
    • addedOutput schema / properties / data / items / properties / ratios / additionalProperties / properties / basis
      Added value: +{
      +  "const": "recomputed_from_facts",
      +  "description": "Present when the pipeline value was replaced by the Worker's own computation from the annual facts (net_debt, fcf_margin, debt_to_equity, *_cagr_Ny), so every tool quotes one definition. `detail` states it.",
      +  "type": "string"
      +}
    • removedOutput schema / properties / lineage / properties / pit_safe / const
      Removed value: -false
  4. Changed1 schema field changed
    • addedOutput schema / properties / data / items / properties / ratios / additionalProperties / properties / derived_id
      Added value: +{
      +  "description": "Citation id of this ratio (drv1:<cik>:pipeline:ratio.<name>@1:period_end=...): cite it like a fact_id; verify_facts re-reads the ratio row and reproduces `display`. Absent when the figure cannot be re-read as quoted (TTM or quarterly rows, a server-corrected sign).",
      +  "type": "string"
      +}
  5. Changed25 schema fields changed
    • changedInput schema / properties / as_of_date / description
      Previous value: -"Historical cutoff, YYYY-MM-DD: ratios filed by this date, or for periods ending by it when no filing date is held, e.g. 2024-06-30."New value: +"Historical cutoff (canonical cross-tool date param). PIT by SEC accepted_at when the ratio data carries it (latest value knowable on/before the date, zero look-ahead, _meta.pit_safe=true), else by ratio.period_end (pit_safe=false). For guaranteed accepted_at PIT use get_company_fundamentals."
    • changedInput schema / properties / categories / description
      Previous value: -"Groups to include: profitability, liquidity, leverage, efficiency, per_share, owner_earnings, forensic, growth, rank or valuation; omit for all, e.g. [\"profitability\"]."New value: +"Ratio categories to include (see the enum). Omit to return every category this ticker has. `valuation` (pe_ratio, pb_ratio, ev_ebitda, market_cap, dividend_yield) is LIVE since schema 2.18.0 — price-derived, period-end-aligned, not strictly PIT. Availability is per-ticker (the envelope lists this ticker's available_categories)."
    • changedInput schema / properties / fiscal_period / description
      Previous value: -"Period type: FY, TTM, Q1, Q2, Q3 or Q4; omit for FY and TTM rows, e.g. TTM."New value: +"Filter to a specific fiscal period type. Use 'TTM' for trailing twelve months. Omit to return both annual (FY) and TTM rows."
    • changedInput schema / properties / limit / description
      Previous value: -"Number of period-end dates to return, 1 to 20; defaults to 5, e.g. 3."New value: +"Number of distinct period_end dates to return (1–20). Defaults to 5. Within each period, all matching ratio_names are included."
    • addedInput schema / properties / period_end_before
      Added value: +{
      +  "description": "Alias of as_of_date (as_of_date preferred — the canonical name). Returns ratios with period_end on or before this date.",
      +  "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      +  "type": "string"
      +}
    • changedInput schema / properties / ticker / description
      Previous value: -"Ticker symbol or SEC CIK of the company, e.g. AAPL."New value: +"Stock ticker symbol, e.g. AAPL, MSFT — or a CIK (SEC identifier), e.g. '0000320193'."
    • addedOutput schema / properties / _meta / properties / cost_usd
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Per-call cost transparency. Omitted for subscription-only tools that have no PAYG-equivalent price.",
      +  "properties": {
      +    "amount_usd": {
      +      "minimum": 0,
      +      "type": "number"
      +    },
      +    "basis": {
      +      "description": "payg_charge = real agent-pay charge. payg_rate_card = indicative price, not billed.",
      +      "enum": [
      +        "payg_charge",
      +        "payg_rate_card"
      +      ],
      +      "type": "string"
      +    },
      +    "billed": {
      +      "description": "true = this amount was actually charged via PAYG for this call. false = indicative PAYG-equivalent value; your plan already covers this call for free.",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "amount_usd",
      +    "billed",
      +    "basis"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / _meta / properties / data_plan
      Added value: +{
      +  "description": "Access plan: sample | sp500 | pro | full",
      +  "type": "string"
      +}
    • changedOutput schema / properties / _meta / properties / fundamentals_as_of / description
      Previous value: -"Use THIS — not `last_updated` — when telling a user how current the cross-sectional fundamentals are. The snapshot is republished on every weekday price refresh while the statements are carried forward unchanged, so `last_updated` can be far more recent than the numbers it sits next to. It is a floor for a single filer, not a ceiling: a filer with a live partition receives its filing, facts and ratios intraday (minutes after EDGAR dissemination), so an entity-scoped read may carry a filing newer than this; cross-sectional ranks (factor scores, earnings signals) refresh with the weekly bulk export."New value: +"ISO timestamp when the FINANCIAL STATEMENTS were last rebuilt in bulk. Use THIS — not `last_updated` — when telling a user how current the cross-sectional fundamentals are. The snapshot is republished on every weekday price refresh while the statements are carried forward unchanged, so `last_updated` can be far more recent than the numbers it sits next to. It is a floor for a single filer, not a ceiling: a filer with a live partition receives its filing, facts and ratios intraday (minutes after EDGAR dissemination), so an entity-scoped read may carry a filing newer than this; cross-sectional ranks (factor scores, earnings signals) refresh with the weekly bulk export."
    • addedOutput schema / properties / _meta / properties / last_updated
      Added value: +{
      +  "description": "ISO timestamp when the snapshot was exported",
      +  "type": "string"
      +}
    • addedOutput schema / properties / _meta / properties / latency_ms
      Added value: +{
      +  "description": "Wall-clock milliseconds this tool call took, measured server-side around the handler.",
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedOutput schema / properties / _meta / properties / limit_warnings
      Added value: +{
      +  "description": "Soft-warning array for partial fulfillment. Each entry carries a stable subcode + remediation.options[]. AI agents pattern-match on subcode.",
      +  "items": {
      +    "additionalProperties": true,
      +    "properties": {
      +      "code": {
      +        "const": "LIMIT_EXCEEDED",
      +        "type": "string"
      +      },
      +      "current_plan": {
      +        "type": "string"
      +      },
      +      "extensions": {
      +        "additionalProperties": {},
      +        "type": "object"
      +      },
      +      "limit_type": {
      +        "type": "string"
      +      },
      +      "limit_value": {},
      +      "remediation": {
      +        "additionalProperties": true,
      +        "properties": {
      +          "contact_sales": {
      +            "type": "string"
      +          },
      +          "default_action": {
      +            "type": "string"
      +          },
      +          "options": {
      +            "items": {
      +              "additionalProperties": {},
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "pricing_page": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "options",
      +          "default_action",
      +          "pricing_page",
      +          "contact_sales"
      +        ],
      +        "type": "object"
      +      },
      +      "requested_value": {},
      +      "returned_value": {},
      +      "subcode": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "code",
      +      "subcode",
      +      "limit_type",
      +      "current_plan",
      +      "remediation"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / _meta / properties / payg_override
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Set when this single response was paid for via the agent-pay PAYG flow — the rate-limit / depth-limit checks were bypassed for this call only.",
      +  "properties": {
      +    "amount_cents": {
      +      "type": "number"
      +    },
      +    "entity_scope_hash": {
      +      "type": "string"
      +    },
      +    "meter": {
      +      "type": "string"
      +    },
      +    "quote_id": {
      +      "type": "string"
      +    },
      +    "retry_token_hash": {
      +      "type": "string"
      +    },
      +    "ticker_count": {
      +      "type": "number"
      +    },
      +    "tool": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "quote_id",
      +    "tool",
      +    "meter",
      +    "amount_cents",
      +    "ticker_count",
      +    "entity_scope_hash",
      +    "retry_token_hash"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / _meta / properties / rate_limit
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Caller's remaining budget",
      +  "properties": {
      +    "limit": {
      +      "type": "integer"
      +    },
      +    "remaining": {
      +      "type": "integer"
      +    },
      +    "reset_at": {
      +      "description": "ISO 8601 timestamp when the window resets",
      +      "type": "string"
      +    },
      +    "window": {
      +      "enum": [
      +        "minute",
      +        "hour"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "limit",
      +    "remaining",
      +    "reset_at",
      +    "window"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / _meta / properties / request_id
      Added value: +{
      +  "description": "Per-request correlation id (8-char)",
      +  "type": "string"
      +}
    • addedOutput schema / properties / _meta / properties / schema_version
      Added value: +{
      +  "description": "Parquet schema version from manifest.json",
      +  "type": "string"
      +}
    • addedOutput schema / properties / _meta / properties / snapshot
      Added value: +{
      +  "description": "Snapshot directory name (e.g. snapshot_20260420)",
      +  "type": "string"
      +}
    • addedOutput schema / properties / _meta / properties / truncation / properties / current_plan
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / _meta / properties / truncation / properties / upgrade_required_for
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / _meta / properties / truncation / properties / upgrade_url
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / properties / _meta / required
      Previous value: -[
      -  "source",
      -  "pit_safe"
      -]New value: +[
      +  "data_plan",
      +  "schema_version",
      +  "snapshot",
      +  "last_updated",
      +  "source",
      +  "pit_safe"
      +]
    • addedOutput schema / properties / data / items / properties / ratios / additionalProperties / properties / display / description
      Added value: +"The ratio rendered exactly as it should be quoted (31.20%, 1.45x, $6.11). QUOTE THIS VERBATIM instead of converting `value` yourself."
    • changedOutput schema / properties / lineage / description
      Previous value: -"Provenance for pipeline-derived values (the ratio table / the factor_scores table): source table + pipeline computed_at, plus a pointer to the tools that return filing-level lineage. NOT point-in-time (recomputed on each pipeline run)."New value: +"Provenance for pipeline-derived values (ratio.parquet / factor_scores.parquet): source table + pipeline computed_at, plus a pointer to the tools that return filing-level lineage. NOT point-in-time (recomputed on each pipeline run)."
    • addedOutput schema / properties / plan
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "_meta",
      -  "ticker",
      -  "note",
      -  "periods_returned",
      -  "data"
      -]New value: +[
      +  "_meta",
      +  "ticker",
      +  "plan",
      +  "note",
      +  "periods_returned",
      +  "data"
      +]
  6. Changed1 schema field changed
    • removedInput schema / properties / period_end_before
      Removed value: -{
      -  "description": "Older name for as_of_date, same format and meaning; as_of_date wins when both are set, e.g. 2024-06-30.",
      -  "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      -  "type": "string"
      -}
  7. Changed26 schema fields changed
    • changedInput schema / properties / as_of_date / description
      Previous value: -"Historical cutoff (canonical cross-tool date param). PIT by SEC accepted_at when the ratio data carries it (latest value knowable on/before the date, zero look-ahead, _meta.pit_safe=true), else by ratio.period_end (pit_safe=false). For guaranteed accepted_at PIT use get_company_fundamentals."New value: +"Historical cutoff, YYYY-MM-DD: ratios filed by this date, or for periods ending by it when no filing date is held, e.g. 2024-06-30."
    • changedInput schema / properties / categories / description
      Previous value: -"Ratio categories to include (see the enum). Omit to return every category this ticker has. `valuation` (pe_ratio, pb_ratio, ev_ebitda, market_cap, dividend_yield) is LIVE since schema 2.18.0 — price-derived, period-end-aligned, not strictly PIT. Availability is per-ticker (the envelope lists this ticker's available_categories)."New value: +"Groups to include: profitability, liquidity, leverage, efficiency, per_share, owner_earnings, forensic, growth, rank or valuation; omit for all, e.g. [\"profitability\"]."
    • addedInput schema / properties / categories / maxItems
      Added value: +10
    • changedInput schema / properties / fiscal_period / description
      Previous value: -"Filter to a specific fiscal period type. Use 'TTM' for trailing twelve months. Omit to return both annual (FY) and TTM rows."New value: +"Period type: FY, TTM, Q1, Q2, Q3 or Q4; omit for FY and TTM rows, e.g. TTM."
    • changedInput schema / properties / limit / description
      Previous value: -"Number of distinct period_end dates to return (1–20). Defaults to 5. Within each period, all matching ratio_names are included."New value: +"Number of period-end dates to return, 1 to 20; defaults to 5, e.g. 3."
    • changedInput schema / properties / period_end_before / description
      Previous value: -"Alias of as_of_date (as_of_date preferred — the canonical name). Returns ratios with period_end on or before this date."New value: +"Older name for as_of_date, same format and meaning; as_of_date wins when both are set, e.g. 2024-06-30."
    • changedInput schema / properties / ticker / description
      Previous value: -"Stock ticker symbol, e.g. AAPL, MSFT — or a CIK (SEC identifier), e.g. '0000320193'."New value: +"Ticker symbol or SEC CIK of the company, e.g. AAPL."
    • removedOutput schema / properties / _meta / properties / cost_usd
      Removed value: -{
      -  "additionalProperties": false,
      -  "description": "Per-call cost transparency. Omitted for subscription-only tools that have no PAYG-equivalent price.",
      -  "properties": {
      -    "amount_usd": {
      -      "minimum": 0,
      -      "type": "number"
      -    },
      -    "basis": {
      -      "description": "payg_charge = real agent-pay charge. payg_rate_card = indicative price, not billed.",
      -      "enum": [
      -        "payg_charge",
      -        "payg_rate_card"
      -      ],
      -      "type": "string"
      -    },
      -    "billed": {
      -      "description": "true = this amount was actually charged via PAYG for this call. false = indicative PAYG-equivalent value; your plan already covers this call for free.",
      -      "type": "boolean"
      -    }
      -  },
      -  "required": [
      -    "amount_usd",
      -    "billed",
      -    "basis"
      -  ],
      -  "type": "object"
      -}
    • removedOutput schema / properties / _meta / properties / data_plan
      Removed value: -{
      -  "description": "Access plan: sample | sp500 | pro | full",
      -  "type": "string"
      -}
    • changedOutput schema / properties / _meta / properties / fundamentals_as_of / description
      Previous value: -"ISO timestamp when the FINANCIAL STATEMENTS were last rebuilt in bulk. Use THIS — not `last_updated` — when telling a user how current the cross-sectional fundamentals are. The snapshot is republished on every weekday price refresh while the statements are carried forward unchanged, so `last_updated` can be far more recent than the numbers it sits next to. It is a floor for a single filer, not a ceiling: a filer with a live partition receives its filing, facts and ratios intraday (minutes after EDGAR dissemination), so an entity-scoped read may carry a filing newer than this; cross-sectional ranks (factor scores, earnings signals) refresh with the weekly bulk export."New value: +"Use THIS — not `last_updated` — when telling a user how current the cross-sectional fundamentals are. The snapshot is republished on every weekday price refresh while the statements are carried forward unchanged, so `last_updated` can be far more recent than the numbers it sits next to. It is a floor for a single filer, not a ceiling: a filer with a live partition receives its filing, facts and ratios intraday (minutes after EDGAR dissemination), so an entity-scoped read may carry a filing newer than this; cross-sectional ranks (factor scores, earnings signals) refresh with the weekly bulk export."
    • removedOutput schema / properties / _meta / properties / last_updated
      Removed value: -{
      -  "description": "ISO timestamp when the snapshot was exported",
      -  "type": "string"
      -}
    • removedOutput schema / properties / _meta / properties / latency_ms
      Removed value: -{
      -  "description": "Wall-clock milliseconds this tool call took, measured server-side around the handler.",
      -  "minimum": 0,
      -  "type": "integer"
      -}
    • removedOutput schema / properties / _meta / properties / limit_warnings
      Removed value: -{
      -  "description": "Soft-warning array for partial fulfillment. Each entry carries a stable subcode + remediation.options[]. AI agents pattern-match on subcode.",
      -  "items": {
      -    "additionalProperties": true,
      -    "properties": {
      -      "code": {
      -        "const": "LIMIT_EXCEEDED",
      -        "type": "string"
      -      },
      -      "current_plan": {
      -        "type": "string"
      -      },
      -      "extensions": {
      -        "additionalProperties": {},
      -        "type": "object"
      -      },
      -      "limit_type": {
      -        "type": "string"
      -      },
      -      "limit_value": {},
      -      "remediation": {
      -        "additionalProperties": true,
      -        "properties": {
      -          "contact_sales": {
      -            "type": "string"
      -          },
      -          "default_action": {
      -            "type": "string"
      -          },
      -          "options": {
      -            "items": {
      -              "additionalProperties": {},
      -              "type": "object"
      -            },
      -            "type": "array"
      -          },
      -          "pricing_page": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "options",
      -          "default_action",
      -          "pricing_page",
      -          "contact_sales"
      -        ],
      -        "type": "object"
      -      },
      -      "requested_value": {},
      -      "returned_value": {},
      -      "subcode": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "code",
      -      "subcode",
      -      "limit_type",
      -      "current_plan",
      -      "remediation"
      -    ],
      -    "type": "object"
      -  },
      -  "type": "array"
      -}
    • removedOutput schema / properties / _meta / properties / payg_override
      Removed value: -{
      -  "additionalProperties": false,
      -  "description": "Set when this single response was paid for via the agent-pay PAYG flow — the rate-limit / depth-limit checks were bypassed for this call only.",
      -  "properties": {
      -    "amount_cents": {
      -      "type": "number"
      -    },
      -    "entity_scope_hash": {
      -      "type": "string"
      -    },
      -    "meter": {
      -      "type": "string"
      -    },
      -    "quote_id": {
      -      "type": "string"
      -    },
      -    "retry_token_hash": {
      -      "type": "string"
      -    },
      -    "ticker_count": {
      -      "type": "number"
      -    },
      -    "tool": {
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "quote_id",
      -    "tool",
      -    "meter",
      -    "amount_cents",
      -    "ticker_count",
      -    "entity_scope_hash",
      -    "retry_token_hash"
      -  ],
      -  "type": "object"
      -}
    • removedOutput schema / properties / _meta / properties / rate_limit
      Removed value: -{
      -  "additionalProperties": false,
      -  "description": "Caller's remaining budget",
      -  "properties": {
      -    "limit": {
      -      "type": "integer"
      -    },
      -    "remaining": {
      -      "type": "integer"
      -    },
      -    "reset_at": {
      -      "description": "ISO 8601 timestamp when the window resets",
      -      "type": "string"
      -    },
      -    "window": {
      -      "enum": [
      -        "minute",
      -        "hour"
      -      ],
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "limit",
      -    "remaining",
      -    "reset_at",
      -    "window"
      -  ],
      -  "type": "object"
      -}
    • removedOutput schema / properties / _meta / properties / request_id
      Removed value: -{
      -  "description": "Per-request correlation id (8-char)",
      -  "type": "string"
      -}
    • removedOutput schema / properties / _meta / properties / schema_version
      Removed value: -{
      -  "description": "Parquet schema version from manifest.json",
      -  "type": "string"
      -}
    • removedOutput schema / properties / _meta / properties / snapshot
      Removed value: -{
      -  "description": "Snapshot directory name (e.g. snapshot_20260420)",
      -  "type": "string"
      -}
    • removedOutput schema / properties / _meta / properties / truncation / properties / current_plan
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / _meta / properties / truncation / properties / upgrade_required_for
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / _meta / properties / truncation / properties / upgrade_url
      Removed value: -{
      -  "type": "string"
      -}
    • changedOutput schema / properties / _meta / required
      Previous value: -[
      -  "data_plan",
      -  "schema_version",
      -  "snapshot",
      -  "last_updated",
      -  "source",
      -  "pit_safe"
      -]New value: +[
      +  "source",
      +  "pit_safe"
      +]
    • removedOutput schema / properties / data / items / properties / ratios / additionalProperties / properties / display / description
      Removed value: -"The ratio rendered exactly as it should be quoted (31.20%, 1.45x, $6.11). QUOTE THIS VERBATIM instead of converting `value` yourself."
    • changedOutput schema / properties / lineage / description
      Previous value: -"Provenance for pipeline-derived values (ratio.parquet / factor_scores.parquet): source table + pipeline computed_at, plus a pointer to the tools that return filing-level lineage. NOT point-in-time (recomputed on each pipeline run)."New value: +"Provenance for pipeline-derived values (the ratio table / the factor_scores table): source table + pipeline computed_at, plus a pointer to the tools that return filing-level lineage. NOT point-in-time (recomputed on each pipeline run)."
    • removedOutput schema / properties / plan
      Removed value: -{
      -  "type": "string"
      -}
    • changedOutput schema / required
      Previous value: -[
      -  "_meta",
      -  "ticker",
      -  "plan",
      -  "note",
      -  "periods_returned",
      -  "data"
      -]New value: +[
      +  "_meta",
      +  "ticker",
      +  "note",
      +  "periods_returned",
      +  "data"
      +]
  8. Changed1 schema field changed
    • changedOutput schema / properties / _meta / properties / fundamentals_as_of / description
      Previous value: -"ISO timestamp when the FINANCIAL STATEMENTS were last rebuilt. Use THIS — not `last_updated` — when telling a user how current the fundamentals are. The snapshot is republished on every weekday price refresh while the statements are carried forward unchanged, so `last_updated` can be far more recent than the numbers it sits next to."New value: +"ISO timestamp when the FINANCIAL STATEMENTS were last rebuilt in bulk. Use THIS — not `last_updated` — when telling a user how current the cross-sectional fundamentals are. The snapshot is republished on every weekday price refresh while the statements are carried forward unchanged, so `last_updated` can be far more recent than the numbers it sits next to. It is a floor for a single filer, not a ceiling: a filer with a live partition receives its filing, facts and ratios intraday (minutes after EDGAR dissemination), so an entity-scoped read may carry a filing newer than this; cross-sectional ranks (factor scores, earnings signals) refresh with the weekly bulk export."
  9. Changed2 schema fields changed
    • changedInput schema / properties / ticker / description
      Previous value: -"Stock ticker symbol, e.g. AAPL, MSFT"New value: +"Stock ticker symbol, e.g. AAPL, MSFT — or a CIK (SEC identifier), e.g. '0000320193'."
    • changedInput schema / properties / ticker / pattern
      Previous value: -"^[A-Za-z.\\-]+$"New value: +"^[A-Za-z0-9.\\-]+$"
  10. Changed4 schema fields changed
    • addedOutput schema / properties / _meta / properties / fundamentals_as_of
      Added value: +{
      +  "description": "ISO timestamp when the FINANCIAL STATEMENTS were last rebuilt. Use THIS — not `last_updated` — when telling a user how current the fundamentals are. The snapshot is republished on every weekday price refresh while the statements are carried forward unchanged, so `last_updated` can be far more recent than the numbers it sits next to.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / _meta / properties / price_as_of
      Added value: +{
      +  "description": "ISO timestamp when the price surfaces were last refreshed.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / data / items / properties / ratios / additionalProperties / properties / display
      Added value: +{
      +  "description": "The ratio rendered exactly as it should be quoted (31.20%, 1.45x, $6.11). QUOTE THIS VERBATIM instead of converting `value` yourself.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • changedOutput schema / properties / data / items / properties / ratios / additionalProperties / required
      Previous value: -[
      -  "value",
      -  "unit",
      -  "category"
      -]New value: +[
      +  "value",
      +  "unit",
      +  "display",
      +  "category"
      +]
  11. Changed2 schema fields changed
    • addedOutput schema / properties / _meta / properties / cost_usd
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Per-call cost transparency. Omitted for subscription-only tools that have no PAYG-equivalent price.",
      +  "properties": {
      +    "amount_usd": {
      +      "minimum": 0,
      +      "type": "number"
      +    },
      +    "basis": {
      +      "description": "payg_charge = real agent-pay charge. payg_rate_card = indicative price, not billed.",
      +      "enum": [
      +        "payg_charge",
      +        "payg_rate_card"
      +      ],
      +      "type": "string"
      +    },
      +    "billed": {
      +      "description": "true = this amount was actually charged via PAYG for this call. false = indicative PAYG-equivalent value; your plan already covers this call for free.",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "amount_usd",
      +    "billed",
      +    "basis"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / _meta / properties / latency_ms
      Added value: +{
      +  "description": "Wall-clock milliseconds this tool call took, measured server-side around the handler.",
      +  "minimum": 0,
      +  "type": "integer"
      +}
  12. Changed1 schema field changed
    • changedInput schema / properties / categories / description
      Previous value: -"Ratio categories to include (see the enum). Omit to return every category this ticker has. `valuation` is accepted but NOT yet populated (price feed pending) → CATEGORY_NOT_AVAILABLE, not data. Availability is per-ticker (the envelope lists this ticker's available_categories)."New value: +"Ratio categories to include (see the enum). Omit to return every category this ticker has. `valuation` (pe_ratio, pb_ratio, ev_ebitda, market_cap, dividend_yield) is LIVE since schema 2.18.0 — price-derived, period-end-aligned, not strictly PIT. Availability is per-ticker (the envelope lists this ticker's available_categories)."
  13. Changed3 schema fields changed
    • changedInput schema / properties / as_of_date / description
      Previous value: -"Historical cutoff (canonical cross-tool date param — same name as get_company_fundamentals / get_valuation_metrics). When the ratio data carries an SEC accepted_at timestamp, this filters point-in-time by accepted_at (returns the latest value knowable on or before the date, zero look-ahead, _meta.pit_safe=true). When it does not (current data), it filters by ratio.period_end and is not strict point-in-time (_meta.pit_safe=false). For guaranteed accepted_at-based PIT, use get_company_fundamentals."New value: +"Historical cutoff (canonical cross-tool date param). PIT by SEC accepted_at when the ratio data carries it (latest value knowable on/before the date, zero look-ahead, _meta.pit_safe=true), else by ratio.period_end (pit_safe=false). For guaranteed accepted_at PIT use get_company_fundamentals."
    • changedInput schema / properties / categories / description
      Previous value: -"Ratio categories to include. Omit to return all categories this ticker has. Served: profitability, liquidity, leverage, efficiency, per_share, owner_earnings, forensic, growth, rank. valuation is accepted but NOT yet populated for any ticker (price feed pending) — it returns a CATEGORY_NOT_AVAILABLE envelope, not data. Availability is per-ticker; the envelope lists this ticker's available_categories."New value: +"Ratio categories to include (see the enum). Omit to return every category this ticker has. `valuation` is accepted but NOT yet populated (price feed pending) → CATEGORY_NOT_AVAILABLE, not data. Availability is per-ticker (the envelope lists this ticker's available_categories)."
    • changedInput schema / properties / period_end_before / description
      Previous value: -"Alias of as_of_date — either works; as_of_date is preferred (it is the canonical name used across every time-series tool). Returns only ratios with period_end on or before this date."New value: +"Alias of as_of_date (as_of_date preferred — the canonical name). Returns ratios with period_end on or before this date."
  14. Changed1 schema field changed
    • addedOutput schema / properties / _meta / properties / pit_safe / description
      Added value: +"true iff a zero-look-ahead point-in-time cut was applied to every returned figure"
  15. Changed2 schema fields changed
    • changedInput schema / properties / categories / description
      Previous value: -"Ratio categories to include. Omit to return all categories. Options: profitability, liquidity, leverage, efficiency, per_share, owner_earnings, valuation."New value: +"Ratio categories to include. Omit to return all categories this ticker has. Served: profitability, liquidity, leverage, efficiency, per_share, owner_earnings, forensic, growth, rank. valuation is accepted but NOT yet populated for any ticker (price feed pending) — it returns a CATEGORY_NOT_AVAILABLE envelope, not data. Availability is per-ticker; the envelope lists this ticker's available_categories."
    • changedInput schema / properties / categories / items / enum
      Previous value: -[
      -  "profitability",
      -  "liquidity",
      -  "leverage",
      -  "efficiency",
      -  "per_share",
      -  "owner_earnings",
      -  "valuation"
      -]New value: +[
      +  "profitability",
      +  "liquidity",
      +  "leverage",
      +  "efficiency",
      +  "per_share",
      +  "owner_earnings",
      +  "forensic",
      +  "growth",
      +  "rank",
      +  "valuation"
      +]
  16. Changed2 schema fields changed
    • changedInput schema / properties / as_of_date / description
      Previous value: -"Historical cutoff (canonical cross-tool date param — same name as get_company_fundamentals / get_valuation_metrics). Returns only ratios whose period_end is on or before this date. NOTE: ratios are pipeline-derived and filtered by period_end, NOT by filing accepted_at, so they are not strict point-in-time (_meta.pit_safe=false). For accepted_at-based PIT, use get_company_fundamentals."New value: +"Historical cutoff (canonical cross-tool date param — same name as get_company_fundamentals / get_valuation_metrics). When the ratio data carries an SEC accepted_at timestamp, this filters point-in-time by accepted_at (returns the latest value knowable on or before the date, zero look-ahead, _meta.pit_safe=true). When it does not (current data), it filters by ratio.period_end and is not strict point-in-time (_meta.pit_safe=false). For guaranteed accepted_at-based PIT, use get_company_fundamentals."
    • addedOutput schema / properties / lineage
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Provenance for pipeline-derived values (ratio.parquet / factor_scores.parquet): source table + pipeline computed_at, plus a pointer to the tools that return filing-level lineage. NOT point-in-time (recomputed on each pipeline run).",
      +  "properties": {
      +    "computed_at": {
      +      "type": "string"
      +    },
      +    "derivation": {
      +      "const": "pipeline_computed",
      +      "type": "string"
      +    },
      +    "note": {
      +      "type": "string"
      +    },
      +    "pit_safe": {
      +      "const": false,
      +      "type": "boolean"
      +    },
      +    "source_table": {
      +      "type": "string"
      +    },
      +    "verify_with": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "source_table",
      +    "derivation",
      +    "pit_safe",
      +    "note",
      +    "verify_with"
      +  ],
      +  "type": "object"
      +}
  17. Changed2 schema fields changed
    • addedInput schema / properties / as_of_date
      Added value: +{
      +  "description": "Historical cutoff (canonical cross-tool date param — same name as get_company_fundamentals / get_valuation_metrics). Returns only ratios whose period_end is on or before this date. NOTE: ratios are pipeline-derived and filtered by period_end, NOT by filing accepted_at, so they are not strict point-in-time (_meta.pit_safe=false). For accepted_at-based PIT, use get_company_fundamentals.",
      +  "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      +  "type": "string"
      +}
    • changedInput schema / properties / period_end_before / description
      Previous value: -"Historical cutoff: only return ratios with period_end on or before this date. Use this instead of as_of_date — ratio data has no PIT accepted_at."New value: +"Alias of as_of_date — either works; as_of_date is preferred (it is the canonical name used across every time-series tool). Returns only ratios with period_end on or before this date."
  18. Changed2 schema fields changed
    • addedOutput schema / properties / data / items / properties / is_calendar_aligned
      Added value: +{
      +  "type": [
      +    "boolean",
      +    "null"
      +  ]
      +}
    • changedOutput schema / properties / data / items / required
      Previous value: -[
      -  "period_end",
      -  "fiscal_year",
      -  "fiscal_period",
      -  "is_ttm",
      -  "computed_at",
      -  "ratios"
      -]New value: +[
      +  "period_end",
      +  "fiscal_year",
      +  "fiscal_period",
      +  "is_ttm",
      +  "is_calendar_aligned",
      +  "computed_at",
      +  "ratios"
      +]
  19. Changed3 schema fields changed
    • addedOutput schema / properties / _meta / properties / payg_override / properties / entity_scope_hash
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / _meta / properties / payg_override / properties / ticker_count
      Added value: +{
      +  "type": "number"
      +}
    • changedOutput schema / properties / _meta / properties / payg_override / required
      Previous value: -[
      -  "quote_id",
      -  "tool",
      -  "meter",
      -  "amount_cents",
      -  "retry_token_hash"
      -]New value: +[
      +  "quote_id",
      +  "tool",
      +  "meter",
      +  "amount_cents",
      +  "ticker_count",
      +  "entity_scope_hash",
      +  "retry_token_hash"
      +]
  20. Changed1 schema field changed
    • addedOutput schema / properties / _meta / properties / payg_override
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Set when this single response was paid for via the agent-pay PAYG flow — the rate-limit / depth-limit checks were bypassed for this call only.",
      +  "properties": {
      +    "amount_cents": {
      +      "type": "number"
      +    },
      +    "meter": {
      +      "type": "string"
      +    },
      +    "quote_id": {
      +      "type": "string"
      +    },
      +    "retry_token_hash": {
      +      "type": "string"
      +    },
      +    "tool": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "quote_id",
      +    "tool",
      +    "meter",
      +    "amount_cents",
      +    "retry_token_hash"
      +  ],
      +  "type": "object"
      +}
  21. Changed1 schema field changed
    • addedOutput schema / properties / _meta / properties / limit_warnings
      Added value: +{
      +  "description": "Soft-warning array for partial fulfillment. Each entry carries a stable subcode + remediation.options[]. AI agents pattern-match on subcode.",
      +  "items": {
      +    "additionalProperties": true,
      +    "properties": {
      +      "code": {
      +        "const": "LIMIT_EXCEEDED",
      +        "type": "string"
      +      },
      +      "current_plan": {
      +        "type": "string"
      +      },
      +      "extensions": {
      +        "additionalProperties": {},
      +        "type": "object"
      +      },
      +      "limit_type": {
      +        "type": "string"
      +      },
      +      "limit_value": {},
      +      "remediation": {
      +        "additionalProperties": true,
      +        "properties": {
      +          "contact_sales": {
      +            "type": "string"
      +          },
      +          "default_action": {
      +            "type": "string"
      +          },
      +          "options": {
      +            "items": {
      +              "additionalProperties": {},
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "pricing_page": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "options",
      +          "default_action",
      +          "pricing_page",
      +          "contact_sales"
      +        ],
      +        "type": "object"
      +      },
      +      "requested_value": {},
      +      "returned_value": {},
      +      "subcode": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "code",
      +      "subcode",
      +      "limit_type",
      +      "current_plan",
      +      "remediation"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
  22. Changed3 schema fields changed
    • addedOutput schema / properties / _meta / properties / truncation
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Set when fewer rows were returned than requested — explains why and points to a remedy",
      +  "properties": {
      +    "current_plan": {
      +      "type": "string"
      +    },
      +    "plan_limit": {
      +      "minimum": 0,
      +      "type": "integer"
      +    },
      +    "reason": {
      +      "enum": [
      +        "PLAN_LIMIT",
      +        "DATA_NOT_AVAILABLE",
      +        "FISCAL_YEAR_BOUNDARY_FILTER",
      +        "OTHER"
      +      ],
      +      "type": "string"
      +    },
      +    "requested": {
      +      "minimum": 0,
      +      "type": "integer"
      +    },
      +    "returned": {
      +      "minimum": 0,
      +      "type": "integer"
      +    },
      +    "upgrade_required_for": {
      +      "type": "string"
      +    },
      +    "upgrade_url": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "requested",
      +    "returned",
      +    "reason"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / data / items / properties / ratios / additionalProperties / properties / detail
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / data / items / properties / ratios / additionalProperties / properties / reason
      Added value: +{
      +  "type": "string"
      +}
  23. Changed3 schema fields changed
    • addedOutput schema / properties / _meta / properties / data_quality
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Server-side invariants run on this response",
      +  "properties": {
      +    "notes": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "validation_failed": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "detail": {
      +            "type": "string"
      +          },
      +          "rule": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "rule",
      +          "detail"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "validation_passed": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "validation_passed",
      +    "validation_failed",
      +    "notes"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / _meta / properties / rate_limit
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Caller's remaining budget",
      +  "properties": {
      +    "limit": {
      +      "type": "integer"
      +    },
      +    "remaining": {
      +      "type": "integer"
      +    },
      +    "reset_at": {
      +      "description": "ISO 8601 timestamp when the window resets",
      +      "type": "string"
      +    },
      +    "window": {
      +      "enum": [
      +        "minute",
      +        "hour"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "limit",
      +    "remaining",
      +    "reset_at",
      +    "window"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / _meta / properties / request_id
      Added value: +{
      +  "description": "Per-request correlation id (8-char)",
      +  "type": "string"
      +}
  24. Changed1 schema field changed
    • changedInput schema / properties / period_end_before / description
      Previous value: -"Historical cutoff: only return ratios with period_end on or before this date. Use this instead of as_of_date — ratio data has no PIT knowledge_at."New value: +"Historical cutoff: only return ratios with period_end on or before this date. Use this instead of as_of_date — ratio data has no PIT accepted_at."
  25. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Goes well beyond the readOnly annotations: discloses that valuation is LIVE but not strictly PIT (no accepted_at), that category availability varies per ticker and how to recover from DATA_NOT_AVAILABLE_FOR_PERIOD, the is_calendar_aligned join caveat, and that null values carry a reason rather than being real zeros. The recomputed_from_facts basis and derived_id citation behavior are exactly the kind of context annotations cannot express.

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

Conciseness3/5

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

Information-rich but dense and repetitive: the as_of_date PIT caveat is restated from the schema, the valuation/PIT caveat appears twice, and several sentences are long status-code parentheticals. It is front-loaded with purpose, but a good portion of the middle could be trimmed without losing meaning.

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?

Given a 6-parameter tool with an output schema and read-only annotations, this covers the remaining burdens: category availability, PIT versus live caveats, TTM/FY mixing, calendar alignment, null semantics, lineage pointers, and derived_id citation. Nothing an agent needs to call or interpret it correctly 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 already 100%, but the description adds real semantics: omitting `categories` returns whatever the ticker has, `as_of_date` falls back from accepted_at PIT to period_end PIT (pit_safe=false), and `period_end_before` is an alias. `limit` is left to the schema, which already documents it, so it does not fully earn a 5.

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

Purpose5/5

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

Opens with a specific verb+resource ('Get pipeline-computed financial ratios from ratio.parquet') and enumerates the served categories, so the agent knows exactly what data comes back. It also names the sibling it differs from (get_valuation_metrics) directly in the text.

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

Usage Guidelines5/5

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

Explicit routing: 'Use this *instead of* get_valuation_metrics when you only need ratios (no DCF wiring); use get_valuation_metrics when you also need DCF/DDM.' It further routes PIT needs to get_company_fundamentals and provenance checks to verify_fact_lineage, so alternatives are named with the exact condition that selects each.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.