Skip to main content
Glama

Periodical report for a date range

get_periodical_report
Read-onlyIdempotent

Retrieve a printable periodical report for a cash register over a date range, including Z-report totals by tax rate and payment form, returns, cash in register, and each Z-report number and date.

Instructions

Returns the periodical report (періодичний звіт) of the cash register behind CHECKBOX_LICENSE_KEY for a date range, as printable text: totals built from the Z-reports of the period, by tax rate and payment form, returns, cash in the register and each Z-report with its number and date. The API offers this report as text only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shortNoRequest the short form of the report. Default false.
to_dateYesEnd of the period. ISO 8601 with a UTC offset, e.g. 2026-10-01T00:00:00+03:00 (Kyiv is +02:00 in winter, +03:00 in summer).
from_dateYesStart of the period. ISO 8601 with a UTC offset, e.g. 2026-10-01T00:00:00+03:00 (Kyiv is +02:00 in winter, +03:00 in summer).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds genuinely useful context beyond them: the output is text-only via the API, and it enumerates what the report contains (totals by tax rate, payment form, returns, cash in register, each Z-report with number and date).

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?

A single dense sentence that front-loads the verb, resource and scoping key, then lists the report contents. No filler or repetition, though the inline enumeration is long enough to be slightly heavy.

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 usefully compensates by describing the returned text's content and noting the API is text-only. Combined with annotations covering the safety profile, an agent has nearly everything needed; only explicit sibling routing is missing.

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%, and the schema documents from_date, to_date and short with ISO 8601 examples, so baseline 3 applies. The description mentions the date range but adds no format or semantics beyond what the schema already provides, and never addresses the 'short' flag.

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?

The description states a specific verb+resource: 'Returns the periodical report ... of the cash register ... for a date range.' It also enumerates the report's contents (Z-report totals by tax rate and payment form, returns, cash in register). It does not explicitly differentiate itself from siblings like get_report or list_reports, so it stops short of a 5.

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 date-range framing and the mention of CHECKBOX_LICENSE_KEY, but there is no explicit when-to-use vs when-not, and no routing to get_report or list_reports for other report types. Context is inferable but not stated.

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