get_officetel_trades

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

No annotations provided, so description carries full burden. Discloses return structure (total_count, items, summary, error handling) and that it fetches from an API. No side effects mentioned, but it's a read operation. Could mention rate limits, but data retrieval tool is well-described.

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?

Description is well-organized with sections for args and returns. Each sentence adds value, though it is longer than minimal. Front-loaded with purpose.

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 parameter count of 3, description covers all parameters with usage hints. Output schema present, but description still details fields. References sibling tools for utility. Could explain officetel more, but sufficient for the agent.

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 coverage is 0%, so description must compensate. It explains region_code as a 5-digit legal district code from get_region_code, year_month as YYYYMM format with fallback, and num_of_rows as max records with default 100. Adds meaning beyond schema types.

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 it returns officetel sale records and summary statistics for a region and month. The verb 'Return' and resource 'officetel sale records' are specific. Distinguishes from siblings like get_apartment_trades by mentioning comparison with apartment prices.

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?

Explicitly states the use case: compare officetel prices against apartment prices. Provides parameter guidance (use get_region_code for region_code, call get_current_year_month if not specified). Does not explicitly list when not to use, 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.