Skip to main content
Glama

get_sales_report

Read-onlyIdempotent

Summarise the Cockatoo invoice report for an inclusive date range on the business clock. Amounts are AUD minor units. Narrow the date range if truncated.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "from": "<from>",
      "to": "<to>"
    },
    "name": "get_sales_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
toYes
fromYes
basisNoissued

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare it as a read-only, idempotent, closed-world, non-destructive call, so the safety profile is covered. The description adds genuinely non-obvious behavior: results are bounded to the business timezone clock, amounts are returned in AUD minor units, and output can be truncated. It still omits what the summary contains and how truncation is signalled.

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?

Three short sentences, each doing distinct work: operation, range semantics, unit convention, and the truncation remedy. Front-loaded with the action and free of filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/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 discloses the currency unit convention and the truncation fallback, and covers two of three parameters. It is still incomplete because `basis` is unexplained and the shape of the returned summary is never described.

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 carry the load; it does clarify that from/to are inclusive and evaluated on the business clock, which the raw date patterns do not convey. However, the `basis` enum (issued/paid) is never mentioned, leaving a required semantic choice entirely undocumented.

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?

Uses a specific verb+resource ("Summarise the Cockatoo invoice report") scoped to an inclusive date range, which is clearly distinct from the sibling list/status/settings tools. It does not explicitly name a sibling or say what makes it different from e.g. get_sales_document_status, so it stops short of full differentiation.

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?

Provides one concrete operational cue — "Narrow the date range if truncated" — which tells the agent how to react to a partial result. It gives no guidance on when to prefer this over the sales-document listing tools, nor any prerequisites or exclusions.

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