Skip to main content
Glama

Dimensional breakdown by fact ID

get_dimensional_breakdown_by_fact_id
Read-onlyIdempotent

Return one consolidated fact plus every slice fact it breaks down into. Slice facts are grouped by the set of XBRL axes their dimensions sit on. Scope: filing_id OR ticker + fiscal_year (+ optional quarter). recursive defaults to true; set recursive=false to return only the immediate children. Pricing: ceil((1+N)/5)×10 where N = returned slice facts (the root counts as one fact in the same batch). Returns 404 (still charged 10 credits) when fact_id is not in this filing. POST /api/v1/data/facts/dimensional-breakdown; FINANCIAL_API_DOCUMENTATION.md.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tickerNoCompany ticker, e.g. "AAPL" (US), "000100" (Korea), "1332" (Japan), "VIRI_F" (Europe), "600519_CN" (China A-share). Use with fiscal_year when filing_id is omitted.
fact_idYesfact_id of the consolidated fact to expand (≤ 128 chars).
quarterNoQuarter label, e.g. "Q1"–"Q4" or "FY". Only needed to disambiguate quarterly filings.
filing_idNoNumeric filing id (from list_filings). Provide either filing_id, or ticker + fiscal_year.
form_typeNoFiling form. US: "10-K" / "10-Q"; foreign annual: "20-F" / "40-F"; Korean (DART): "10-K" (annual) / "10-Q" (quarterly). Defaults to "10-K".10-K
recursiveNoWhen true (default), expand every level of dimensional children; when false, only the immediate children.
fiscal_yearNoReporting fiscal year (1990–2100). Required together with ticker when filing_id is omitted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Beyond the annotations, the description discloses several important behaviors: recursion defaults to true and can be disabled, pricing is computed from the returned slice fact count, and a 404 still costs 10 credits. It also explains that slice facts are grouped by XBRL axes. This adds significant context beyond the readOnly/idempotent hints.

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 information-dense and front-loaded with the core behavior, then scope, recursion, pricing, and error semantics. The endpoint and documentation reference at the end are slightly redundant, but nearly every clause adds useful operational detail.

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?

The description covers the key call-time decisions: scope, recursion, pricing, and the 404 case. Since there is no output schema, the description explains the return shape at a conceptual level (consolidated fact plus grouped slice facts) but does not detail the response fields. This is sufficient for correct invocation.

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 every parameter. The description restates the filing_id-vs-ticker scoping and recursive default, but it does not add meaningful new detail about parameter formats, allowed values, or relationships beyond what the schema provides. 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 names the specific verb and resource: it returns one consolidated fact plus every slice fact it breaks down into. It also clarifies the grouping principle (by XBRL axes) and the fact_id-based scope, which separates it from the sibling get_dimensional_breakdown_by_line_item.

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

Usage Guidelines4/5

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

The description gives clear context for invoking the tool: it specifies the two valid scoping forms (filing_id OR ticker + fiscal_year), optional quarter, and the recursive flag with its default. It does not explicitly name alternatives or state when not to use this tool, so it falls short of a 5.

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