local_ydb_dump_tenant

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

Annotations indicate write operation (readOnlyHint=false) and not destructive (destructiveHint=false). The description adds critical behavioral details such as the plan-only mode when confirm is omitted, the directory creation under profile.dumpHostPath/dumpName, and exclusion of .sys objects. No contradiction with annotations.

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 two sentences, with the first sentence being dense but front-loaded with the main purpose. It efficiently conveys key actions and conditions. Minor improvement could be to break the first sentence for readability.

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 absence of an output schema, the description adequately explains the dump process, including plan-only behavior, directory structure, and system object exclusion. It does not cover output format but provides sufficient context for a simple dump 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?

All 4 parameters have descriptions in the schema (100% coverage). The description adds context beyond the schema, e.g., referencing profile.dumpHostPath/dumpName and the effect of confirm=true/false on the operation, enhancing understanding of parameter usage.

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 it dumps a tenant using a local-ydb helper container, specifying the creation of directories, exclusion of .sys objects, and the plan-only vs actual dump behavior. It effectively distinguishes from sibling tools like local_ydb_restore_tenant by focusing on dump operations.

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 description explains when to use confirm=true vs false (plan vs actual dump) and mentions the static container network. However, it does not provide explicit guidance on when to prefer this tool over alternatives like local_ydb_restore_tenant or local_ydb_create_tenant, lacking a clear differentiation of use cases.

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