snapshot_config

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

The description adds real detail beyond the annotations: a file is written locally, its permissions are 0600, and the call returns an identifier. However, it does not say where the file is stored, whether repeated calls overwrite or accumulate, or what happens on failure. There is also mild tension with readOnlyHint=true, since writing a local file is a side effect, though the managed router state is untouched.

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 front-loaded sentence that states the action, the artifact, the security-relevant file mode, and the return value. Every clause carries information; nothing is padded.

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?

With no parameters and an output schema covering the returned id, the description is close to sufficient. The remaining gap is storage location and snapshot lifecycle behavior (overwrite vs. accumulate), which an agent calling this on a real device would plausibly want.

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; there is nothing for the description to disambiguate. The description sensibly spends its words on scope ('every readable setting') rather than nonexistent inputs.

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 names a specific verb and object ('Save every readable setting') plus the concrete artifact produced ('a local snapshot file (0600)') and its return value ('returns its id'). This is clearly distinguishable from siblings such as list_snapshots and diff_config, though it never names those siblings explicitly.

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?

Usage is only implied: an agent can infer this is the way to capture current router configuration for later comparison or rollback. There is no explicit statement of when to prefer this over diff_config, check_desired_state, or list_snapshots, and no mention of prerequisites or whether it should precede a mutation.

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