Get Instances Payins

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

The annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=true, and destructiveHint=false, so the safety profile is covered. The description adds no behavioral context such as pagination behavior, required instance scoping, or what the returned payin list contains.

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 phrase is short but under-specified rather than usefully concise; it is not structured to front-load scope, required parameters, or filtering behavior. For a 13-parameter list endpoint, this is too terse to guide invocation.

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?

This is a complex list tool with 13 parameters, low schema description coverage, no output schema, and many sibling tools. The description does not explain scoping, filtering, pagination, or return semantics, leaving an agent without enough context to invoke it reliably.

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 description coverage is only 31% across 13 parameters, so the description must compensate for undocumented parameters. "Retrieve Payins" provides no meaning for required instance_id, filters like status/customer_id/payment_method, or pagination cursors.

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 "Retrieve Payins" essentially restates the tool name and title (Get Instances Payins -> Retrieve Payins). It identifies the resource but does not explain that this is a scoped list operation or distinguish it from siblings such as GetV1InstancesPayinsById.

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?

There is no guidance about when to use this list endpoint versus GetV1InstancesPayinsById or other payin-related tools. It also gives no indication of how filters such as status, customer_id, or pagination parameters should be used.

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