Skip to main content
Glama

Get full metrics bundle

get_metrics_bundle
Read-onlyIdempotent

Return the full metrics bundle for one metric_group_id (all computed ratios and line-backed metrics for that filing-period snapshot). These are precomputed metrics, not XBRL facts — for individual line-item values use query_line_items or get_filing_facts. The response always includes both a filing-date price block and a realtime price block; the realtime block returns a hint when current_price is omitted. If you only need the filing-date computation, call get_metrics_bundle_filing_date instead. Call list_metric_snapshots first to obtain metric_group_id. Optional: accept_suggested_formula and formula_override for user-formula metrics (per API rules), as_of_date, current_price (USD; supply to compute realtime price-sensitive ratios; must be > 0, ≤ 10,000,000, ≤ 4 decimal places; omit to receive a hint in the realtime block instead), current_fx_rate (optional fallback FX rate used only when an up-to-date conversion rate is temporarily unavailable on foreign-issuer filings; > 0, ≤ 1,000,000, ≤ 6 decimal places), light_weight_mode (bool, default false; strip per-metric audit fields to reduce payload size). 148 credits. POST /api/v1/metric/all; see 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.8/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, and the description adds context beyond that: it states the response includes both filing-date and realtime price blocks, that the realtime block returns a hint when current_price is omitted, and discloses credits (148) and the exact endpoint (POST /api/v1/metric/all). This gives an agent a clear model of what happens on invocation without contradicting 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 long but densely packed; it front-loads the core purpose and then methodically covers distinctions, response behavior, prerequisites, and each optional parameter with constraints. While it could be tightened, every sentence carries useful information and the structure is logical. It earns a 4 rather than a 5 because of its length, though it is not verbose.

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?

Despite the tool having 7 parameters and many siblings, the description covers the critical context: what the tool returns, how to obtain the required metric_group_id, cost, endpoint, plan requirements, and parameter-specific behavior. Since there is no output schema, the description also gives a useful note about response composition (both price blocks and the hint behavior). It leaves no obvious gap an agent would need to resolve before calling it correctly.

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 value by explaining the purpose and behavior of parameters beyond their schema descriptions. For example, it explains that current_price is 'supply to compute realtime price-sensitive ratios' and that omitting it 'receive a hint instead', and that light_weight_mode is meant to 'strip per-metric audit fields to reduce payload size'. It also frames formula_override as 'for user-formula metrics (per API rules)', which is helpful context not found in the schema alone.

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 opens with a specific verb and resource: 'Return the full metrics bundle for one metric_group_id' and clarifies it covers 'all computed ratios and line-backed metrics for that filing-period snapshot.' It clearly differentiates from siblings by stating these are 'precomputed metrics, not XBRL facts' and explicitly names query_line_items and get_filing_facts as the alternative for line-item values, plus get_metrics_bundle_filing_date for filing-date-only needs.

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?

It gives explicit when-to-use and when-not-to-use guidance: directs users to call list_metric_snapshots first to obtain metric_group_id, tells them to use query_line_items or get_filing_facts for line-item values, and says to call get_metrics_bundle_filing_date if only the filing-date computation is needed. It also includes plan-level prerequisites (Starter or higher, Pro+ for formula_override) which helps an agent decide if it can invoke it.

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