get_payins

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

With no annotations, the description carries the full burden. It discloses pagination behavior and merchant scope, and the HTTP method '[GET /payins]' implies a read-only, side-effect-free operation. It doesn't mention error conditions or ordering, but the core behavior is explicit.

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 extremely concise — a single line with three segments separated by em dashes. It front-loads the action and object, with zero fluff or repetition.

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 simple list tool with no output schema, the description covers the essential purpose, scope, and pagination. It doesn't explain response format or filtering options, but those are already captured in the schema. Minor gap: no mention of the reference filter or default behavior.

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 100%, so a baseline of 3 applies. The description mentions pagination, which aligns with page/page_size parameters, but adds no meaning beyond what the schema already provides. The reference filter is not mentioned.

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 uses specific verbs ('List', 'Retrieve') and clearly identifies the resource ('Payins') and scope ('all Payins', 'paginated', 'for the merchant'). It effectively distinguishes from siblings like get_payin_by_id and get_payouts.

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?

The description clearly implies when to use the tool (listing all payins with pagination) and the 'all Payins' scope differentiates it from single-item retrieval. It lacks explicit alternatives or exclusions, but the context is clear.

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