Get a Shopify Record

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

Annotations already declare readOnly/idempotent/openWorld/non-destructive, so the safety profile is covered. The description adds genuinely non-obvious behavior: 'Follow each returned cursor independently' for pagination and 'Partial exports stay marked incomplete' for bulk operations, plus the per-resource return contents.

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 core purpose is front-loaded in one sentence, followed by a scannable per-resource list where each bullet carries distinct information. It is long but nearly every line earns its place; density is acceptable given nine resource modes.

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 multi-mode read tool with no output schema, the description covers what each resource returns and its id type well. It falls short only on the store parameter, the pagination params (after/first), and any auth/rate-limit context.

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 56%, so the description must compensate, and it does meaningfully: it explains that 'id' is a different GID type per resource (Product, Collection, Order, InventoryItem, MediaImage, etc.), and clarifies the optional 'namespace'/'key' and 'filenames' behavior. However, `store`, `after`, and `first` are never explained in the description or 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?

States a specific verb+resource+scope: 'Read one record by GID from one store.' The resource list enumerates exactly what kinds of records can be fetched, clearly distinguishing a direct GID read from sibling search/query tools.

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?

Usage is implied by 'Read one record by GID,' but there is no explicit when-to-use or when-not guidance (e.g., versus shopify_search or shopify_graphql_query) and no stated prerequisites. The agent must infer that a GID is required to prefer this over searching.

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