lan.snapshot

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

With no annotations, the description carries the behavioral burden; it does disclose that save captures the current lan.devices list and that snapshots are dated, which tells the agent this mode mutates stored state while list is a read. It omits key traits such as whether a same-day save overwrites, where snapshots live, and any retention limit.

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?

A single compact sentence with the write action front-loaded and the secondary read action trailing. No filler, and the two modes are separated by a clear semicolon.

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 one-parameter tool with no output schema, the description covers the essentials, but it leaves real gaps: what a list result looks like, where snapshots are stored, and what happens on repeated saves. An agent can call it correctly but cannot predict the outcome of list or repeated saves.

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 coverage is 0%, but the enum values are self-describing and the description maps each to concrete behavior (save = snapshot current devices, list = enumerate snapshots), which is more than the bare enum provides. It doesn't restate the schema's default of 'list' for an omitted mode.

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 gives a specific verb and resource: it saves the current lan.devices list into a dated snapshot, or lists existing snapshots. It ties the write behavior to the lan.devices sibling, making the data source unambiguous, but it doesn't distinguish itself from other lan.* siblings beyond that reference.

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 two clauses imply which mode to pick (save vs list), but there is no explicit guidance on when to snapshot versus just calling lan.devices, and no mention that omitting mode defaults to list. Usage is inferable rather than stated.

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