save_snapshot

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

The description reveals that the tool persists data to a directory and is version-sensitive, but does not detail side effects, permissions required, or the exact behavior beyond saving. Without annotations, this is adequate but not rich.

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 concise sentences, each essential: the first states the core action, the second adds an important constraint. No wasted 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?

The tool is simple (1 param, no output schema), but the description lacks parameter details and does not mention return value or error conditions. It does provide the version constraint, which is helpful context for usage with load_snapshot.

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 single parameter 'directory' is not described in the schema (0% coverage) and the description provides no additional meaning about its expected format, purpose, or behavior. The agent is left guessing what 'directory' refers to.

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 action ('Persist the design + source index') and the purpose ('fast reload'). It distinguishes itself from sibling tool 'load_snapshot' by referencing it and noting version compatibility, making its role unique.

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 when to use (to save for fast reload) and provides a key constraint (version tie-in with load_snapshot rejecting foreign versions). However, it does not explicitly state when not to use or list alternative tools beyond load_snapshot.

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