Get Instances Payouts

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

Annotations already declare this as a safe, read-only, idempotent, open-world operation. The description adds no context beyond that—no mention of pagination behavior, filtering constraints, response shape, or instance scoping.

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?

It is extremely short and front-loaded, but this is under-specification rather than useful conciseness. Two words cannot carry the needed meaning for a 13-parameter list endpoint.

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?

For a complex collection-listing tool with multiple filters, pagination options, no output schema, and sparse schema descriptions, the description is completely inadequate. It gives the agent almost nothing needed to call the tool correctly.

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 tool has 13 parameters with only 31% schema description coverage, and the description provides no parameter semantics at all. Many enum and filter parameters (status, country, network, customer_id, payment_method, etc.) are left undocumented in both schema and description.

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 gives a specific verb and resource ("Retrieve Payouts"), so the basic purpose is understandable. However, it does not clarify that this returns a collection scoped to an instance, nor differentiate it from the sibling GetV1InstancesPayoutsById.

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 on when to use this endpoint versus the by-ID sibling or how to choose among the many filters. At best, usage is implied by the name.

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