getInvoicePaymentsById

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

Discloses the tool is success-only and may omit refunds. Without annotations, it lacks information on error handling, required permissions, or response structure. The vague 'may not show' reduces certainty.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Two concise sentences with no wasted words. The primary purpose is front-loaded in the first sentence.

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

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Adequate for a simple retrieval tool with two parameters and no output schema. Could be more complete by mentioning error scenarios or payment ordering.

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

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

Schema covers 100% of parameters with descriptions. The description adds no extra meaning to invoiceId or __userContext beyond what the schema provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it retrieves successful payments for a specific invoice ID. It hints at filtering (success-only, no refund rows) but does not explicitly differentiate from siblings like getInvoicePayments or getInvoicePaymentsWithoutRefunds.

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

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

Implied usage: use when you need successful payments for an invoice. However, no explicit guidance on when not to use this tool vs alternatives like getInvoicePayments or listAllPayments.

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