shopify_get_inventory

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It only says 'Get inventory levels' and offers an optional filter. It does not state whether the operation is read-only (likely, but unconfirmed), whether it returns all inventory items or paginates, or if any permissions are required. This is a significant gap for a tool that mutates nothing but still needs to convey response shape and 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?

The description is a single, efficient sentence that front-loads the primary action ('Get Shopify inventory levels') and mentions the optional filter. There is no fluff or redundancy. It could be more informative without losing conciseness, but as written, it is appropriately brief.

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 tool has a single optional parameter and no output schema, the description should still convey what the agent can expect in terms of response (e.g., list of items, counts, pagination) and default behavior when locationId is omitted. None of this is covered. For a simple tool, the description is minimal but leaves the agent guessing about the output structure and edge cases.

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%, and the only parameter is locationId (string). The description adds that filtering by location is optional, which gives some meaning to locationId. However, it does not explain the format of the locationId (e.g., numeric string, a resource ID), what happens if omitted, or how the response is affected. With low coverage, the description should compensate more thoroughly, but it only offers a brief hint.

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?

States a clear verb+resource: 'Get Shopify inventory levels'. The purpose is unambiguous and the tool name aligns. However, it does not differentiate from siblings like odoo_get_stock_level, which could also retrieve inventory (though for a different system). Since the name itself implies Shopify, and the description confirms it, it's clear but lacks explicit sibling differentiation.

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 mentions an optional filter ('optionally filtered by location') but provides no guidance on when to choose this tool over alternatives such as odoo_get_stock_level or when locationId should be provided. There are no exclusions or context about scenarios where this tool is preferred. An agent would have to infer usage from the name alone.

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