Skip to main content
Glama

finance

Reports: Get income statement

get_income_statement
Read-onlyIdempotent
    Get an income statement (profit & loss) for a time period.

    The window spans exactly ``months`` calendar months back from today.
    When that predates the user's first transaction, the start is clamped
    to the first-activity date and ``period.clamped_to_first_activity`` is
    true (``period.requested_start_date`` echoes the un-clamped start) —
    so a "6 months" label backed by only 3 months of real data is
    detectable, matching the other analytics tools (rule 35).

    Args:
        months: Number of months to cover (default: 6). Values <= 0 return
            a validation error. Values > 24 are clamped to a 24-month window
            but ``period.requested_months`` / ``period.clamped_months`` echo
            the original request so the clamp is detectable.

    Returns:
        Income and expense breakdown by category with totals, plus a
        ``period`` block with start/end/months + the clamp metadata
        (requested_months, clamped_months, requested_start_date,
        clamped_to_first_activity).
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
monthsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Annotations declare read-only/idempotent/non-destructive, and the description adds substantial behavior beyond them: calendar-month window semantics, clamping to first-activity date with detectable metadata, and the <=0 / >24 validation/clamp rules. This is rich behavioral disclosure.

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?

Front-loaded with purpose, then behavior, then Args/Returns. Well-organized but somewhat verbose with repeated clamp-detection narration across the period and months paragraphs.

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?

No output schema exists, so the Returns block is needed and present, describing both the income/expense breakdown and the period metadata fields. Covers everything an agent needs to call and interpret results.

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% and only a bare integer 'months' with default exists, so the description must compensate fully. It does: describes default, boundary behavior (<=0 error, >24 clamped), and the echo fields that make clamping detectable.

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+resource ('Get an income statement (profit & loss)') and names the exact time window ('months' calendar months back). Distinguishable from siblings like get_balance_sheet and get_cash_flow by the explicit P&L framing.

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?

Implies usage (retrieving period analytics) and references 'rule 35' and 'other analytics tools', but never states when to choose this over get_period_summary, get_spending_summary, or get_cash_flow. No explicit when-not guidance.

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