Skip to main content
Glama

get_kpi_report

Snapshot KPIs + 13-week liquidity forecast, from the GL (CompanyMember).

Cash/liability balances aggregate the FY window of posted/reversed journal lines; aging + forecast read gl_open_item, pending salary batches and unpaid VAT periods. Read-only. Explicit non-member company_id → 403.

fiscal_year optional → latest FY with journal data; FY figures as of that year's end once past. Aging and forecast anchor to today.

Input Schema

NameRequiredDescriptionDefault
company_idYes
fiscal_yearNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/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 and does well: it declares 'Read-only', specifies that a non-member company_id yields 403, and explains default resolution for fiscal_year (latest FY with journal data; FY figures frozen at that year's end once past; aging/forecast anchored to today). Only rate-limit/performance behavior is absent, which is minor for a read-only report.

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-loads the headline purpose, then layers data sources, permissions, and the parameter default in dense but non-redundant sentences. Every clause carries information; slightly telegraphic phrasing but no filler.

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 and no annotations, the description is the sole carrier of context and covers what is returned, where it comes from, who may call it, and how the fiscal_year default resolves. It stops short of listing the individual KPIs, but is otherwise 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 0%, so the description must compensate. It gives rich semantics for fiscal_year (optionality, default resolution, as-of-year-end behavior) but explains company_id only indirectly via the 403 membership note, leaving its format/identity unclear. Partial compensation only.

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 (KPI report / snapshot) and enumerates exactly what it contains: snapshot KPIs plus a 13-week liquidity forecast drawn from the GL. It also names the underlying data sources (posted/reversed journal lines, gl_open_item, salary batches, VAT periods), which cleanly separates it from siblings like gl_balance_sheet or gl_profit_and_loss.

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?

Usage is implied by the content scope (a KPI/liquidity snapshot), but the description never says when to pick this over the many sibling reporting tools (get_financial_statements, gl_trial_balance, reconciliation_summary) or any exclusion conditions. An agent gets the gist but no explicit routing.

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