snapshot_config

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

With no annotations, the description must convey behavioral traits. It implies a snapshot operation but doesn't disclose if it's destructive, requires special permissions, or what happens to existing data. The term 'snapshot' is ambiguous—could be read or write. The schema suggests writing (requires config_data), but the description doesn't confirm.

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?

While extremely short (3 words), this is not effective conciseness. It omits critical information, making it under-specified rather than succinct. A single sentence that adds context would be better.

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 two parameters, including a nested object, no output schema, and no annotations, the description is grossly incomplete. It fails to explain what the tool does with the config data or what happens after calling it.

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 for explaining parameters. It does not explain 'config_name' or 'config_data' at all. The description adds no semantic meaning beyond the raw schema, leaving the agent to guess their purpose.

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 'Snapshot current config' gives a general sense of capturing configuration state, but it's vague. It doesn't specify whether it reads or writes, nor what 'config' refers to. Compared to siblings like 'kb_get' or 'investigation_get', it lacks clarity on the exact action and resource.

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 on when to use this tool versus alternatives. There is no mention of prerequisites, typical use cases, or warnings about when not to use it. The description is too brief to provide any usage context.

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