Skip to main content
Glama

get_sales_report

Read-only

Retrieve a sales summary for today, this week, or this month, including revenue, total orders, units sold, and low-stock alerts.

Instructions

Retrieve a summary report of revenue, total sales orders, units sold, and low-stock alerts.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
periodNoTime range for the sales report (default: 'today').

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoResult data payload from Chirak API.
successNoStatus of the tool execution.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A3.6/5.0
Behavior3/5

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

The readOnlyHint annotation already signals a safe read operation, so the description does not need to repeat that. It adds some useful context by enumerating the report contents, but it does not disclose additional behavior such as data freshness, aggregation scope beyond the period parameter, or whether low-stock alerts span all products.

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?

A single, front-loaded sentence that names the resource and its key contents with no filler. Every word contributes to understanding the tool's purpose.

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 simple read-only reporting tool with an output schema, an optional enum parameter documented in the schema, and a readOnlyHint annotation, the description is nearly sufficient. It lacks explicit routing guidance relative to siblings, but nothing critical is missing for safe 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?

The single parameter 'period' is fully documented in the input schema, including its enum values and default. The description adds no further parameter-level meaning, but with 100% schema coverage, the baseline of 3 is appropriate.

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 uses a clear verb ('Retrieve') and identifies a specific resource ('summary report') with concrete contents (revenue, total sales orders, units sold, low-stock alerts). It is immediately obvious what this tool does and how it differs from inventory-focused siblings like get_inventory.

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

Usage Guidelines2/5

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

No guidance is given about when to use this tool versus alternatives such as get_inventory, search_product, or record_sale. The context is implied by the name and content, but no explicit usage conditions, exclusions, or prerequisites are provided.

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