Skip to main content
Glama

MetricDuck — Financial Analysis

IR Earnings Decks

get_ir_documents
Read-only

Retrieve IR earnings-PRESENTATION-DECK text — forward guidance, operational KPIs, and segment outlook that are ONLY in the company's investor-relations slide deck and NOT in the SEC 8-K/10-Q release text or XBRL.

Reach for this when get_metric_history / get_xbrl_facts have no series for a KPI or guidance figure, or the 8-K earnings release from get_filing_section lacks it (decks are a separate source): production or revenue guidance ranges, segment/division outlook, KPIs shown as slide charts (e.g., berth capacity %, Mboed production guidance, adjusted-EBITDA guidance).

Use Cases:

  • "OXY Q3 2024 production guidance" -> get_ir_documents("OXY", fiscal_year=2024, fiscal_period="Q3", query="production guidance")

  • "NCLH berth capacity outlook" -> get_ir_documents("NCLH", fiscal_year=2021, fiscal_period="Q3", query="berth")

  • "KNTK adjusted EBITDA guidance range" -> get_ir_documents("KNTK", fiscal_year=2023, fiscal_period="Q3", query="EBITDA")

Each deck returns its title, original IR url, a stable MetricDuck-hosted gcs_uri, and the matching slide text cited by page. Pass a query to land on the exact page; omit it for a bounded prefix of the latest deck. Resolve by ticker or cik; narrow with fiscal_year/fiscal_period.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
cikNo10-digit SEC CIK as an alternative to ticker (e.g., '0000797468').
modeNoResponse mode. 'full' (default): slide TEXT for the matched deck(s) — combine with query/period to pull a figure. 'list': a cheap one-row-per-item INVENTORY of the company's served IR documents (doc_kind, period, date, links; NO slide text) — use to answer "what IR materials does X have?". In list mode `query` is ignored (it filters slide text).
queryNoKeyword filter over slide text — returns ONLY the deck pages whose text matches every word (whole-word AND, case-insensitive). Use this to pull a specific figure (e.g., query="production guidance", "berth capacity", "adjusted EBITDA guidance") so the response cites the exact page instead of dumping the deck.
tickerNoCompany ticker symbol (e.g., 'OXY'). Required unless cik is provided.
fiscal_yearNoFiscal year of the deck (e.g., 2024). Narrows to one period when combined with fiscal_period.
fiscal_periodNoFiscal period: 'Q3' (with fiscal_year) or combined '2024Q3'. Omit to return the latest deck(s).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / cik / pattern
      Previous value: -"^\\d{10}$"New value: +"^\\d{1,10}$"
  2. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations cover only the safety profile (readOnly/openWorld/non-destructive), but the description adds substantive behavior: the return shape (title, IR url, stable gcs_uri, slide text cited by page), the default when query is omitted ('bounded prefix of the latest deck'), and a genuine mode caveat ('In list mode `query` is ignored'). No output schema exists, so the description rightly carries the return-value burden and does so 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 differentiator is front-loaded in the first sentence, followed by when-to-use and then examples. It is well organized, though the three 'Use Cases' lines partially restate the query guidance given just above, so a small amount of redundancy keeps it short of a 5.

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?

For a 6-parameter, no-output-schema tool, the description supplies everything needed: what each response contains, default behavior with no query/period, the list-vs-full distinction, and resolution by ticker or cik. No material gap remains for an agent to invoke 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 description coverage is 100%, so the baseline is 3; the schema already documents query's whole-word AND semantics and mode's full/list behavior. The description adds concrete query exemplars ('production guidance', 'berth'), the combined fiscal_period form ('2024Q3'), and the ticker-or-cik resolution rule, which gives mild extra value beyond the structured fields.

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?

States a specific verb and resource (retrieve IR earnings presentation deck text) and immediately scopes it against siblings: content 'ONLY in the company's investor-relations slide deck and NOT in the SEC 8-K/10-Q release text or XBRL.' An agent can distinguish this from get_filing_section, get_xbrl_facts, and get_metric_history without opening any 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?

Explicitly names the trigger condition and alternatives: 'Reach for this when get_metric_history / get_xbrl_facts have no series for a KPI or guidance figure, or the 8-K earnings release from get_filing_section lacks it.' It also enumerates the content types (guidance ranges, segment outlook, chart KPIs) that select this tool, leaving nothing to inference.

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