stock

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

Annotations provide readOnlyHint=false and destructiveHint=false. The description adds details about write operations (create, update, transfer, etc.) and return format. However, it does not disclose authorization needs, rate limits, or side effects of destructive operations like 'remove'. The description adds moderate value 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 organized with an intro, operation lists, and parameter details. It is front-loaded but somewhat lengthy given the number of operations. Could be more concise by grouping similar operations or using bullet points, but it is not overly verbose.

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?

For a tool with 11 parameters, multiple operations, and no schema descriptions, the description covers operation types and parameter meanings. The output format is mentioned ('JSON string with stock/location data'), and the presence of an output schema (context signal) reduces the need for detailed return info. Missing details on error handling and nested object structures, but adequate overall.

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 description coverage, the description compensates by explaining each parameter's purpose and usage (e.g., 'part_id: Filter stock by part'). Some explanations remain vague (e.g., 'data: Dict of fields'), but overall it adds significant meaning beyond the raw schema.

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 'Stock item & location management in InvenTree' and enumerates specific read/write operations. While the term 'management' is broad, the operation list provides sufficient specificity. It is distinct from sibling tools like 'part' or 'purchase_order' but does not explicitly differentiate.

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 siblings or when not to use it. The description lists operations but does not provide context for choosing between this and other tools, nor does it mention prerequisites or exclusions.

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