sync_snapshot

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

With no annotations, the description carries the burden and does well: it discloses the output location (ZYXEL_SYNC_DIR), the concrete set of files produced, that the running config is scrubbed, and that no git push occurs. It does not state whether existing files are overwritten, whether the write can be destructive, or what permissions are needed.

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, front-loaded with the action and destination, followed by the one behavioral caveat that matters most for tool selection. No filler.

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?

An output schema exists, so return-value explanation is unnecessary, and the description covers destination, contents, and the git boundary. The remaining gap is edge-case behavior (overwrite semantics, failure when ZYXEL_SYNC_DIR is unset) in a zero-annotation, write-performing 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 tool takes zero parameters, so the baseline is 4. The description does add value by explaining that the destination comes from the ZYXEL_SYNC_DIR environment variable rather than an argument, which is the only 'parameter-like' input.

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?

States a specific verb (Write) and artifact (a rebuild-ready snapshot) and enumerates exactly what the snapshot contains: scrubbed running config, JSON dumps of VLANs/ports/MACs/LLDP, MAC-keyed inventory, topology README. It also explicitly negates the git push, which cleanly separates it from the sync_to_github sibling.

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 final sentence 'Does NOT push to git' is an implicit routing cue toward sync_to_github, and the mention of ZYXEL_SYNC_DIR establishes the precondition for use. There is no explicit 'use this when...' statement or statement of what happens if the env var is unset, so it falls just short of a 5.

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