snapshot_capture

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

With no annotations, the description partially discloses behavioral traits like directory allowlisting and the optional label. However, it does not explicitly state whether the operation is read-only or side-effect-free, nor does it mention performance or permission implications.

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?

The description is concise at about 100 words, front-loaded with a clear purpose, and structured with a 'Parameters' heading and bullet points. Each sentence adds value without repetition or fluff.

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?

Given the tool has 3 parameters, no annotations, and an output schema, the description covers parameter semantics thoroughly and mentions constraint (allowlisted dirs) and filename behavior. Minor gap: it doesn't explicitly state that the snapshot is saved as a JSON file to the directory (though implied), but the presence of an output schema mitigates the need for return value description.

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%, so the description carries full responsibility. It explains all three parameters in detail, including constraints (allowlisted directories), usage hints (label tags), and examples for extra_stat_groups. This adds significant meaning beyond the schema types and defaults.

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 'Capture a structured state snapshot of the running OpenSIPS,' which specifies the verb (capture), resource (structured state snapshot), and context (running OpenSIPS). It is distinct from siblings like snapshot_diff and snapshot_list, which handle existing snapshots.

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?

No guidance is provided on when to use this tool versus alternatives such as snapshot_diff or snapshot_list. The description focuses solely on parameters without mention of prerequisites, exclusions, or when not to use.

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