create_secret

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

The description discloses key behaviors: encryption at rest, value never returned, audit logging, and overwrite behavior. Given no annotations, this coverage is thorough, though it omits potential permission requirements or side effects beyond audit logging.

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, with a clear opening sentence, behavioral notes, and a structured Args section. Every sentence adds value, and there is no redundancy or irrelevant information.

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's simplicity (3 parameters, no output schema), the description covers the purpose, behavior, parameter semantics, and side effects adequately. It does not explain the return value (likely success/failure), but this is minor. The description is sufficient for an agent to understand the tool's function.

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 0% schema coverage, the description must compensate. It adds meaning by explaining each parameter: name as reference, value as encrypted and not logged/returned, description as optional. However, it lacks examples, format constraints, or default values, leaving room for ambiguity.

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: 'Store an encrypted secret in the VibOps vault.' The verb 'store' and resource 'encrypted secret' are specific. While there is no direct sibling for creating secrets, it distinguishes itself from other create tools like create_agent_identity by focusing on 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?

The description mentions overwrite behavior ('If a secret with the same name already exists, it is overwritten.'), which implies usage when creating or updating. However, it does not provide explicit guidance on when to use this tool versus alternatives, such as when to update vs. create anew, or any prerequisites.

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