compare_snapshots

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

No annotations provided; description discloses output format but lacks details on error handling, prerequisites, or whether it modifies data. Implies read-only 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 efficiently describe purpose, output, default behavior, and optional parameters. No unnecessary words.

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?

Explains output includes metric deltas and a human-readable assessment. With no output schema, this provides adequate context. Could specify which metrics are compared.

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 covers all 4 parameters; description adds context about default behavior (latest two snapshots) and the optional nature of snapshot IDs, going beyond 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?

Clearly states the tool compares two performance snapshots for a website, showing metric deltas and a human-readable assessment. Distinguishes from sibling tools like list_sites or get_site_metrics.

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 default behavior (latest two snapshots) and optional explicit IDs, but does not explicitly state when to use this tool versus alternatives like get_site_metrics or get_recommendations.

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