getSales

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior. The description adds context: default time range (1 week), pagination limits (max 100, default 10), and various filtering capabilities. This provides additional behavioral detail beyond annotations.

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 concise (three sentences) yet packs all key information: purpose, default behavior, filter types, pagination, and sibling references. It is well-structured, front-loading the core function and efficiently covering details without redundancy.

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 the complexity (22 parameters, multiple filters), the description covers the main use cases, default behavior, and relationships to other tools. It lacks output structure details, but as a list operation with readOnlyHint, this is acceptable. Overall, it provides sufficient context for effective tool selection and usage.

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 each parameter is documented. The description groups filters (customer, status, email state) and mentions pagination and fields selection, adding high-level context. However, it doesn't provide details not already in schema; it references the schema for specifics.

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 the tool retrieves a list of order data (受注データを一覧取得), specifies default behavior (last week if no params), and distinguishes from siblings like getSale (specific order), statSale (aggregation), and update tools. This provides excellent clarity.

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 explicitly outlines when to use this tool (listing orders) and provides alternatives: getSale for a specific order, statSale for sales totals, updateSale/cancelSale/sendSalesMail for modifications. It also explains default date ranges and filtering options, offering comprehensive usage guidance.

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