get_secret_reference

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

Adds important context beyond annotations: masking behavior for non-system users, returns metadata and masked auth, not the actual secret value.

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?

Two precise sentences: first states action and identifier, second adds critical behavioral nuance. No 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?

Covers retrieval purpose, identification method, return content (metadata + masked auth), and what is NOT returned (secret value). Output schema handles return structure.

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?

Only parameter 'id' is fully documented in schema (100% coverage). Description reiterates 'UUID or slug' but adds no new semantics.

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?

Clearly states 'Retrieve one Secret Reference' with identifier type (UUID or slug), distinguishing it from sibling list/create/update/delete 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?

Implies singular retrieval vs list by using 'one', but lacks explicit when-to-use vs alternatives. Context signals and siblings help differentiate.

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