sops_rotate_generated

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

The description discloses the need for the SOPS_AGE_KEY env var and that external secrets are preserved, but it does not detail side effects like overwriting generated secrets or error conditions when the env var is missing. Given no annotations, more transparency would be beneficial.

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 a single, well-structured sentence that conveys essential information without any unnecessary words or redundancy.

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?

While the description covers the core functionality and an important prerequisite, it lacks details about return values, error handling, and potential side effects. This is adequate for a simple tool but could be more complete.

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 schema has 100% coverage with a description for the only parameter. The description does not add additional meaning beyond what the schema already provides, meeting the baseline.

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's purpose: re-generating 'generated' secrets with new random values while preserving 'external' secrets. It uses a specific verb and resource, and distinguishes from sibling tools like sops_add_secrets.

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?

It mentions the requirement for the SOPS_AGE_KEY environment variable, providing some usage context. However, it does not explicitly state when not to use this tool or mention alternative tools for similar operations.

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