shopify_list_transactions

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

With no annotations, description bears full burden. Only states it lists transactions; no disclosure of pagination behavior, rate limits, error handling for invalid order IDs, or scope of results (e.g., all transactions or limited set). Minimal behavioral context.

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?

Short and focused: two sentences with clear purpose and args section. No wasted words. Front-loaded with action and resource.

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?

Given no annotations and one parameter, description is sparse. Does not cover output schema details (though schema exists), error scenarios, or usage context. For a list tool, missing pagination and ordering details is a gap.

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 0%, so description compensates partially. States order_id is a Shopify order ID (numeric or GID) and marks it as required, which adds format info and usage constraint. However, claim of required contradicts schema (default null, not in required list), causing confusion.

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?

Clearly states the tool lists order transactions for a specific order, enumerating transaction types (authorisations, captures, voids, sales). This verb+resource pattern distinguishes it from other Shopify list tools (e.g., shopify_list_collections, shopify_list_discounts) and sibling tools from other systems.

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 on when to use this tool versus alternatives. Does not mention exclusions, prerequisites, or context for selection among similar tools like shopify_list_refunds or stripe_list_transactions.

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