Skip to main content
Glama

Get filing-date metrics bundle

get_metrics_bundle_filing_date
Read-onlyIdempotent

Like get_metrics_bundle but returns only the filing-date price-sensitive block — no realtime computation. current_price / current_fx_rate are not accepted on this endpoint; if you include them you'll get a warning in the response and they'll be ignored — call get_metrics_bundle (regular /metric/all) instead when you need realtime metrics. Same 148 credits. Use this when you don't need today's market price (analyzing historical filings, batch loads, or any case where current stock price is irrelevant). Optional: accept_suggested_formula, formula_override, as_of_date, light_weight_mode (bool, default false; strip per-metric audit fields to reduce payload size). POST /api/v1/metric/all/filing-date; 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.
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.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so the safety profile is covered. The description adds valuable behavioral context: unsupported parameters are ignored with a warning, the endpoint path is given, credit cost is stated, and plan requirements are disclosed. It doesn't describe the response shape, but with no output schema and read-only annotations, the description carries the behavioral burden well.

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 well-organized, front-loading the key distinction from get_metrics_bundle and the unsupported-parameter warning. It packs endpoint, credits, plan requirements, and parameter notes into a compact block. Slightly long, but every sentence earns its place.

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 read-only, idempotent metrics tool with 100% schema coverage, the description covers the essential context: what it returns, what it doesn't accept, when to use it, the endpoint, credits, and plan requirements. The only notable gap is the lack of any description of the response structure, but since there is no output schema and the tool is a variant of get_metrics_bundle, an agent can infer the response shape from the sibling.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already documents all five parameters. The description adds context for light_weight_mode (strips audit fields to reduce payload) and notes formula_override requires Pro+, but these are minor additions over the schema. Baseline 3 is appropriate.

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 clearly states the tool returns the filing-date price-sensitive block from get_metrics_bundle, with no realtime computation. It names the sibling tool it is not (get_metrics_bundle) and explicitly says current_price/current_fx_rate are not accepted, so an agent can distinguish it from the regular bundle without opening the schema.

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?

The description gives explicit when-to-use guidance: use this when you don't need today's market price, for historical filings, batch loads, or when current stock price is irrelevant. It also names the alternative (get_metrics_bundle) and states the condition for choosing it (when realtime metrics are needed).

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