ym_stocks

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

The annotation readOnlyHint: true already indicates non-destructive behavior. The description adds that it 'returns warehouse stocks per SKU', which is mildly helpful but does not disclose other behavioral traits like pagination limits or authentication needs. With annotations present, the description provides only modest added transparency.

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 two sentences with no fluff. The purpose is stated upfront, and the alternative is mentioned. Every word adds value.

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?

Despite having an output schema, the description does not detail return format or pagination behavior. The three parameters lack any explanation of their purpose or constraints. The tool is simple, but the omission of parameter semantics makes it incomplete for an agent to use effectively.

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 the description must compensate but fails to describe any parameters. The three parameters (page_token, limit, campaign_id) are not explained in the description, leaving the agent to rely on parameter names alone. This is inadequate for correct invocation.

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 'Get product stocks for a campaign. Returns warehouse stocks per SKU.' This specifies the action (get), resource (stocks), and scope (per SKU, per warehouse), and distinguishes it from the sibling ym_stocks_update which handles stock changes.

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 includes 'Use ym_execute with action stocks_update to change stock quantities.' This explicitly tells the agent when to use an alternative tool for modification, clarifying that this tool is for reading only.

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