export_snapshot

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

Discloses that the operation is non-destructive and specifies the exact file location and .gitattributes modification. With no annotations, the description adequately covers key behavioral traits.

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 with no fluff. The action is stated first, then purpose and side effects. Every sentence is meaningful.

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?

For a simple tool with one parameter and no output schema, the description covers the action, output location, side effects, and use case. It does not mention return value or error scenarios, but these are less critical for an export 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 schema already describes the single parameter, but the description adds value by explaining that the snapshot is placed next to the project, which provides context about how the parameter is used.

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 exports the whole store to a compressed snapshot at a specific path, and adds a .gitattributes guard. It distinguishes from sibling tools like import_snapshot and mirror.

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?

Explicitly states 'For sharing project memory with a team via git', providing a clear use case. However, it does not explicitly contrast with alternatives like import_snapshot or describe when not to use it.

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