Skip to main content
Glama
Dxfory

edgar-filings

by Dxfory
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

get_segment_revenue

Retrieve segment-level revenue data (product, business, geographic) from SEC 10-K or 10-Q filings using ticker or CIK, with optional accession for specific filing.

Instructions

Dimensioned XBRL revenue facts from a 10-K or 10-Q (product, business, geographic axes).

This is filing data, not a consolidated income statement. ticker_or_cik: ticker like NVDA or a CIK. accession: optional filing accession; default is the latest of form. form: 10-K (default) or 10-Q.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formNo10-K
accessionNo
ticker_or_cikYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.1.2
    • addedInput schema / properties / form
      Added value: +{
+  "default": "10-K",
+  "title": "Form",
+  "type": "string"
+}
  2. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations, the description carries the full burden. It discloses that the data is filing-level XBRL facts, not a summary, and explains parameter defaults. It does not mention rate limits, pagination, or return structure, but the 'not a consolidated income statement' disclaimer is a key behavioral cue. It is adequate for a read-only retrieval tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

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

The description is concise and well-structured: the first sentence states the core purpose, the second clarifies a key distinction, and the following lines succinctly define parameters. No unnecessary words, and the essential information is front-loaded.

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 tool with no output schema and no annotations, the description covers the essential purpose, scope, and parameter semantics. It does not describe the exact response format or potential complexity (e.g., multiple facts per filing), but given the simplicity of the parameters and the explicit 'filing data' note, it is reasonably complete.

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

Parameters5/5

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

Schema coverage is 0%, so the description fully compensates by explaining every parameter: ticker_or_cik (ticker or CIK), accession (optional, defaults to latest of form), and form (10-K default or 10-Q). This adds significant meaning beyond the bare schema names and defaults.

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 'Dimensioned XBRL revenue facts from a 10-K or 10-Q', specifying the resource (segment revenue) and the filing context. It also differentiates from a consolidated income statement, making the purpose unambiguous and distinct from sibling tools like get_form4 or get_bdc_nonaccrual.

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 provides clear context on when to use the tool (for segment-level revenue facts) and explicitly warns it is not a consolidated income statement. It also explains default behavior for form and accession. However, it does not explicitly name alternative tools or state when NOT to use it beyond the consolidated statement distinction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools