Skip to main content
Glama

PHP Point of Sale MCP by usefulapi

List reports

phppos_list_reports
Read-only

The catalog of the store's reports (138 of them: sales summaries, top sellers, inventory low/aging/summary, profit and loss, taxes, payments, employee, customer, supplier and store-account reports) with the inputs each accepts. Without search only the report keys are returned; with search (for example 'inventory' or 'profit') the matching reports are returned with their inputs. GET /reports.

Input Schema

NameRequiredDescriptionDefault
searchNoOnly reports whose key, description or inputs contain this text.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered; the description adds real value by disclosing the two distinct return shapes (keys only vs. reports with inputs) and the underlying GET /reports endpoint. It does not mention volume/pagination behavior for a 138-item catalog, which is a minor remaining 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?

Two sentences, front-loaded with the resource and the count, then the critical behavioral fork between search and no-search. The parenthetical taxonomy of report types is long but earns its place by helping an agent judge whether a needed report exists.

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 only one optional parameter, the description does the necessary work by describing both return shapes and the endpoint. The only meaningful omission is not naming phppos_run_report as the follow-up tool for a discovered report key.

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 100%, so baseline is 3, but the description adds concrete example search terms ('inventory', 'profit') and, more importantly, explains that search changes the response shape, not just filtering. That is meaning beyond the schema's own 'contain this text' wording.

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?

States a specific verb and resource ('catalog of the store's reports') and enumerates the report families covered, which tells an agent exactly what is returned. It stops short of explicitly distinguishing itself from the sibling phppos_run_report, so the list-vs-execute split must be inferred from 'with the inputs each accepts'.

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?

The description explains the behavior of the search parameter ('without search only the report keys are returned'), which implies the browse-then-filter workflow. It never states when to call this versus phppos_run_report, even though that sibling is the obvious next step after finding a report key.

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.