Skip to main content
Glama

List payments

teachworks_list_payments
Read-only

List customer payments (amount, method, date, refunds, invoice allocations). Filter by customer and date range. GET /payments.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (1-based, default 1).
date_toNoPayment date on or before.
per_pageNoRecords per page (default 20, max 50).
date_fromNoPayment date on or after.
directionNoSort by id ascending (default) or descending (newest first).
customer_idNoOnly payments of this customer.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

readOnlyHint=true already tells the agent this is a safe read operation, so the description needn't re-establish that. It does add value by disclosing the underlying 'GET /payments' endpoint and the shape of returned records (amount, method, date, refunds, invoice allocations), but says nothing about pagination behavior or result volume beyond what the schema implies.

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 compact fragments, purpose front-loaded, no filler. Every clause earns its place and the returned-field list is kept in parentheses rather than bloating the sentence.

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 list tool with no output schema, the description usefully enumerates the fields returned and the filter dimensions, and annotations cover the safety profile. It is nearly complete; only pagination semantics and sort/filter interaction are left unstated.

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% with all six parameters documented (page, per_page, date_from, date_to, direction, customer_id), so the schema carries the full parameter burden. The description's mention of customer and date-range filtering only gestures at two of these and adds no syntax or format detail beyond the schema. Baseline 3 is appropriate.

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 ('List customer payments') and enumerates the returned fields, which makes the read-only listing intent unambiguous. It doesn't explicitly differentiate itself from siblings like teachworks_get_payment or teachworks_create_payment, but the 'List' verb plus filtered scope distinguishes it implicitly.

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 says 'Filter by customer and date range,' which implies when the tool is useful, but it never states when to prefer it over teachworks_get_payment or teachworks_list_invoices. Usage context is implied rather than explicit.

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.