Skip to main content
Glama

Get cash flow metrics

get_cash_flow_metrics
Read-onlyIdempotent

Cash-flow metrics (18 metrics): free_cash_flow, fcf_margin, payout_ratio, free_cash_flow_per_share, free_cash_flow_after_sbc, fcf_ex_sbc_addback, free_cash_flow_cagr_3y, free_cash_flow_cagr_5y, free_cash_flow_cagr_10y, free_cash_flow_per_share_cagr_3y, free_cash_flow_per_share_cagr_5y, free_cash_flow_per_share_cagr_10y, cfo_to_net_income, fcf_to_net_income, cash_distributions_to_fcf, common_dividend_burden_on_group_fcf, sbc_to_revenue, sbc_to_fcf. fcf_margin also appears in get_profitability_metrics. Flat 148-credit cost. POST /api/v1/metric/cash-flow; FINANCIAL_API_DOCUMENTATION.md. Requires the Starter plan or higher; formula_override requires Pro+.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
as_of_dateNoAs-of date "YYYY-MM-DD"; excludes filings filed after this date. Defaults to no cutoff.
current_priceNoCurrent share price in USD for realtime price-sensitive ratios (> 0, ≤ 10,000,000, ≤ 4 decimals). Omit to get a hint instead.
current_fx_rateNoFallback FX rate, used only when an up-to-date conversion rate is briefly unavailable on foreign-issuer filings (> 0, ≤ 1,000,000, ≤ 6 decimals).
metric_group_idYesSnapshot id from list_metric_snapshots identifying one filing-period's computed metrics.
formula_overrideNoOptional per-metric formula overrides, keyed by metric id, e.g. {"interest_coverage": {"concepts": ["OperatingIncomeLoss", "InterestExpense"], "operators": ["/"]}}. Each entry lists XBRL concepts and the operators combining them. Requires the Pro plan or higher.
light_weight_modeNoWhen true, return a leaner payload (drops the most verbose nested fields). Charged the same. Saves context when you already know exactly what you need.
accept_suggested_formulaNoWhen true, accept the server's suggested formula for metrics that need one to compute.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior. The description adds useful context beyond that: flat 148-credit cost, Starter plan requirement, Pro+ requirement for formula_override, and the specific POST endpoint. No contradictions 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.

Conciseness4/5

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

The description is dense but information-rich: the metric list is necessary for tool selection, and cost, plan requirements, and endpoint are each relevant. It lacks sectioning and reads as a run-on, but contains no filler.

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

Completeness4/5

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

For a 7-parameter tool with no output schema, the description covers the metrics returned, cost, plan constraints, and endpoint. The surrounding schema already documents parameter details, so nothing critical for making the call 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. The description adds value by listing the exact metric ids that formula_override would be keyed by and by explicitly noting formula_override requires Pro+, which is not stated in the schema itself.

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?

The description names the specific resource (cash-flow metrics) and enumerates all 18 returned metrics, so an agent knows exactly what this tool offers. It also distinguishes itself from the related profitability tool by noting that fcf_margin also appears in get_profitability_metrics.

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 implies usage for retrieving calculated cash-flow metrics and notes the fcf_margin overlap with get_profitability_metrics, which is a weak routing hint. However, it does not explicitly say when to choose this tool over other metric tools like get_metrics_bundle or get_metrics_subset, nor does it state exclusions.

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.

Resources