shopify_sitemap_urls

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

With no annotations provided, the description carries the full burden. It adds context about 'child sitemaps' and 'capped entries', but this is largely redundant with the schema (limit parameter). It does not disclose other behavioral traits such as authentication needs, rate limits, or output format, which would be useful.

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 consists of two sentences with no wasted words. The first sentence states the core purpose, and the second adds relevant detail about the nature of the results. It is appropriately sized and front-loaded.

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?

The tool is simple with three parameters and no output schema. The description covers the key aspects: listing URLs, from child sitemaps, by type, with a cap. However, it does not describe the output format (e.g., array of strings), which would be helpful given the absence of an output schema. Still, it is mostly complete for the tool's complexity.

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%, so the baseline is 3. The description adds no new information beyond what the schema already provides for each parameter (url, type, limit). It does not enhance understanding of parameter values or constraints.

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 the tool lists Shopify sitemap URLs and explains it fetches capped URL entries from child sitemaps by type. The verb 'list' and resource 'Shopify sitemap URLs' are specific, and it distinguishes from the sibling tool 'shopify_sitemaps' which likely lists available sitemaps rather than their URLs.

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 for obtaining URLs from specific Shopify child sitemaps, but it does not provide explicit guidance on when to use this tool versus alternatives like 'shopify_sitemaps' or 'shopify_products'. No exclusions or when-not-to-use scenarios are mentioned.

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