getPaymentById

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

No annotations are provided, so the description must fully disclose behavior. It only states 'Retrieve details', implying a read operation, but does not mention authentication needs, potential errors (e.g., payment not found), rate limits, or any side effects. The description is insufficient for an unannotated tool.

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?

The description is a single concise sentence that front-loads the tool's purpose without any fluff. Every word earns its place.

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?

The tool has a complex nested __userContext parameter crucial for multi-tenant authentication and approval workflow, yet the description completely ignores it. No output schema is provided, and the description does not explain return values or behavior. For a tool with such complexity and sensitivity, the description is inadequate.

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?

The input schema has 100% description coverage: paymentId is described as 'The unique ID of the payment to retrieve.' and __userContext has a full description. The tool description adds no additional meaning beyond what the schema already provides. Baseline score of 3 is appropriate.

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 'Retrieve details for a specific payment by its ID.' It specifies the verb (retrieve), resource (details of a payment), and method (by ID). This distinguishes it from sibling tools like listAllPayments (list all) and other getters like getInvoicePaymentsById (which gets payments for an invoice).

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?

No guidance is provided on when to use this tool versus alternatives such as listAllPayments, getInvoicePaymentsById, or refundPayment. There is no mention of prerequisites or context. The implied usage (when you have a payment ID) is present, but no explicit when-not or alternatives are given.

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