Skip to main content
Glama

Get finance report

get_finance_report
Read-only

Downloads a monthly financial report as tab-separated text, covering earnings by region and currency for a chosen fiscal month.

Instructions

Downloads a monthly financial report (earnings by region and currency) as tab-separated text. Needs an API key with the Finance role.

Input Schema

NameRequiredDescriptionDefault
maxRowsNoMaximum report rows to return.
regionCodeNoRegion code: ZZ for all regions consolidated (FINANCIAL), Z1 for FINANCE_DETAIL, or a code such as US or EU.ZZ
reportDateYesFiscal month as YYYY-MM, e.g. 2026-09 (Apple's fiscal calendar).
reportTypeNoFINANCIAL: per-region summary. FINANCE_DETAIL: all regions in detail (use regionCode Z1).FINANCIAL
vendorNumberNoVendor number, shown in App Store Connect under Payments and Financial Reports (top left). Omit it to use the one configured in APP_STORE_CONNECT_VENDOR_NUMBER.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered; the description goes beyond them by disclosing the authentication requirement (Finance role) and the response encoding (tab-separated text). It does not mention truncation behavior when maxRows is hit or whether a report for a not-yet-released fiscal month errors out.

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?

Two short sentences, output format and subject front-loaded, auth requirement second. Nothing is redundant with the name or title.

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?

With no output schema, the description correctly states the return shape (TSV earnings by region and currency) and the auth gate. For a read-only report tool that is nearly enough; only the unavailability/truncation cases and the choice against get_sales_report remain uncovered.

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%, with the enum, defaults, pattern, and bounds all documented inline, so the schema carries the parameter burden. The description only adds a loose mapping ('monthly' → reportDate, 'by region and currency' → regionCode) and no format or edge-case detail beyond it.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Downloads a monthly financial report') plus the content ('earnings by region and currency') and format ('tab-separated text'). It is distinguishable from the nearby get_sales_report sibling by its financial/earnings framing, though it never names that sibling to sharpen the contrast.

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

Usage Guidelines3/5

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

The description gives a prerequisite ('Needs an API key with the Finance role') but no when-to-use rule and no pointer to the alternative report tool (get_sales_report) that an agent would likely weigh against this one. Usage context is implied by 'monthly financial report' rather than stated.

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