getTemplatePreview

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

Annotations already indicate readOnly, openWorld, idempotent, non-destructive. Description adds crucial behavioral details beyond annotations: URL expiration, output format (a URL), and that it shows the current shop with the template. No contradictions.

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?

Description is concise yet comprehensive: few sentences cover action, return type, expiration, use cases, and alternatives. Information is front-loaded with the primary function.

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's simplicity (one parameter, no output schema), the description is complete. It explains what the tool does, what it returns, expiration, use cases, and provides cross-references to related tools. No gaps for the agent to make incorrect guesses.

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?

Input schema has 100% coverage with a description for template_id. The description adds context by explaining that providing template_id returns a URL displaying the current shop with that template, clarifying the parameter's role beyond the schema's brief label.

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's purpose: issuing a temporary preview URL for templates in the browser. It distinguishes from sibling tools by explicitly noting getTemplatePage (source retrieval), updateTemplatePage (editing reflection), and getTemplates (listing).

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?

Provides explicit usage context: for checking appearance before editing or after applying updateTemplatePage. Mentions URL expiration (1 hour) and need to reissue. Directly names alternative tools for related tasks.

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