intelligence-api

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

With no annotations provided, the description carries full disclosure burden. It successfully communicates pagination behavior and the 250-item limit constraint. However, it omits authentication requirements, Shopify rate limiting, error handling behavior, and the read-only nature of the operation.

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?

Two sentences with zero waste. The first sentence front-loads the core purpose (fetching paginated catalogs), while the second provides critical operational constraint (250 limit). Every word earns its place.

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 low-complexity tool with 3 simple parameters and complete schema coverage. However, given the absence of both annotations and output schema, the description should ideally disclose return format, authentication requirements, or error behavior to be fully complete.

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 100%, establishing a baseline of 3. The description reinforces the 250 limit mentioned in the schema but does not add syntax details, format examples, or semantic context beyond what the parameter descriptions already provide.

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 uses specific verb 'Fetch' with resource 'paginated product catalog' and scope 'any Shopify store'. It clearly distinguishes from sibling shopify_analyze (analysis vs. fetching) and amazon_product (single product vs. full catalog).

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 implies usage context through 'Fetch' and 'paginated', suggesting use for catalog listing. However, it lacks explicit when-to-use guidance versus siblings like shopify_analyze or amazon_product, and omits prerequisites like store accessibility requirements.

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