ym_order_status

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

Description adds the typical state flow (PROCESSING → DELIVERY → DELIVERED) and mentions substatus as optional, which goes beyond the readOnlyHint annotations. However, it does not disclose any potential side effects, permissions, or transition constraints.

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?

Three concise sentences with no fluff: states purpose, provides flow and args, then gives usage guidance. Front-loaded with the core action.

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?

Adequate for a simple update tool given an output schema exists, but incomplete parameter documentation and lack of details on allowed status values or transition rules limit its completeness.

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?

With 0% schema coverage, description should explain all parameters. It mentions 'status' and 'substatus' with context, but misses the required 'order_id' and optional 'campaign_id' parameters, leaving their meaning and usage unclear.

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?

Clear verb 'Update' with resource 'order status'. Distinguishes from siblings by providing typical flow and explicitly mentioning alternative tool (ym_execute) for batch operations. No ambiguity.

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 when to use this tool (single order status update) and when to use an alternative (ym_execute for multiple orders). Provides typical flow states as guidance.

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