pmg_backup_create

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

The description discloses the mutation nature, dry-run behavior, backup write path, and parameter effects. It does not mention potential side effects (e.g., overwrite behavior) or auth/rate limits, but the disclosure is reasonable for a low-risk mutation.

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 well-structured with the purpose first, followed by usage details and parameter explanations. It is concise but includes some technical verbosity (e.g., exact API path) that could be trimmed without losing clarity.

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?

The description covers prerequisites, execution flow, and parameter semantics. Since an output schema exists, return values are not needed. The tool is sufficiently specified for an AI agent to use correctly.

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?

With only 20% schema coverage, the description adds significant meaning for most parameters: notify options, statistic inclusion, confirm for execution, and node as target. This fully compensates for the sparse schema descriptions.

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 the tool creates a PMG configuration backup, with the prefix 'pmg' distinguishing it from non-PMG backup tools. It specifies the resource (PMG backup) and the action (create), and it is unique among siblings.

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 the dry-run default and that confirm=True is needed to execute, providing clear usage guidance. It also mentions the required config. However, it does not explicitly state when not to use or offer alternatives, but given the tool's specificity, the guidance is adequate.

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