List secrets in a vault

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

Annotations already declare readOnlyHint=true, and the description adds valuable behavioral context: 'Values are never returned by any tool in this server,' preventing a false expectation that secret values might be retrievable. It also states the exact output fields, going beyond the annotated safety profile.

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 one concise sentence that leads with the action, specifies the result fields, and closes with a high-value caveat about secret values. Every part earns its place.

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?

For a simple list tool with one fully documented parameter and read-only annotations, the description covers the purpose, the input, the output fields, and the important limitation that values are never returned. Nothing essential for correct invocation is missing.

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 description coverage is 100%; the only parameter, vault, is already documented as 'Vault id or its 8-character prefix.' The description does not add further parameter-specific meaning, so baseline 3 is appropriate.

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 uses a specific action and resource: 'Lists the secrets of a vault', and names the returned fields (id prefix, name, archived). It clearly distinguishes from sibling tools like oneguard_vault_list, which lists vaults rather than secrets, and from secrets mutation tools.

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 context for using the tool is clear: call it to list secrets for a vault. However, it does not explicitly mention when not to use it or point to alternatives, such as oneguard_secrets_add or oneguard_vault_list.

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