preview_theme

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

With no annotations, the description carries full burden and excels: it discloses that the render uses sample content, stubs dynamic helpers, serves on localhost, stops previous previews, and makes old URLs invalid. All critical behavioral traits are covered.

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 concise, with three short paragraphs. The first sentence states the main action, followed by details on what is rendered and served, and a final behavioral note. No unnecessary words; every sentence 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?

Despite an output schema existing, the description covers all necessary context: purpose, internal behavior, constraints (single preview, live URL expiry), and expected output (URL). It is fully complete for a single-parameter preview tool.

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?

The only parameter, theme_path, is described in the schema as 'Path to the theme directory to preview.' The description does not add further detail (e.g., format, validation). Since schema coverage is 100%, baseline is 3, and no extra value is provided.

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 action: 'Render a Ghost theme locally and serve it for preview in a browser.' It specifies building static renders of home, post, and page templates, differentiating it from sibling tools like activate_theme or upload_theme.

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 guidance on when to use: 'before activating the theme on the live site.' Also notes the single-preview behavior and advises handing the user the most recent URL. However, it does not explicitly exclude alternative scenarios or other tools.

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