Skip to main content
Glama

Field Service Business Platform by Doing Work

taxes_salesReport

Sales tax report for a period (owner or office), shop local dates, from and to inclusive. Uses the shop's basis (shops.setTaxReportBasis) unless basis is given. accrual: invoices sent in the period, with sales, taxable sales, tax billed, and tax collected so far. cash: money collected in the period through Doing Work (payments minus refunds, tips left out), with the tax share of it. Grouped by the tax name, jurisdiction and rate on each invoice. Untaxed sales are one row with no rate. Void invoices are left out. For filing, check the numbers against your own records.

Input Schema

NameRequiredDescriptionDefault
toYes
fromYes
basisNo
shop_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/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 so well: it discloses what is included in each basis, how rows are grouped (tax name, jurisdiction, rate), that untaxed sales collapse into one rate-less row, that void invoices are excluded, that tips are excluded under cash, and that collected amounts are 'so far'. It does not state read-only behavior, permissions, or result-size limits, which leaves a modest gap.

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?

The scope statement is front-loaded and the accrual/cash explanations are dense but each sentence adds distinct semantics. It runs long and some clauses, such as '(owner or office)' and 'shop local dates', are terse enough to be ambiguous rather than merely brief.

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 4-parameter report with no output schema, the description covers the important ground: what the report returns, how it is grouped, which records are excluded, and how basis selection works. Missing are output shape details (row fields ordering, totals), pagination or size limits, and the meaning of 'owner or office'.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must compensate, and it largely does: 'from and to inclusive' pins down the date semantics, and the basis enum values are each defined operationally. The parenthetical '(owner or office)' is ambiguous about what it qualifies, leaving shop_id only weakly explained.

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 opening clause names a specific resource and scope: a sales tax report for a period over an inclusive date range. It is unmistakably a reporting tool rather than a rate-management sibling such as taxes_listRates, taxes_saveRate, or taxes_archiveRate. An agent can tell what it produces and roughly what the rows contain without opening the schema.

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

Usage Guidelines4/5

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

The description effectively explains the accrual-vs-cash distinction and states that the shop default (shops.setTaxReportBasis) applies unless the basis argument is given, which is real guidance for choosing a mode. It also adds a verification caveat for filing purposes. It stops short of explicit when-to-use/when-not phrasing or naming alternative reporting tools.

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