Get Password

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

Adds important behavioral details: reveal requirement for non-null value and potential redaction by NOREVEAL/KEYCHAIN_NOREVEAL. Annotations already indicate readOnlyHint=true; description enhances this without contradiction.

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 tight sentences. First states purpose, second adds crucial behavioral condition. No redundancy, perfectly front-loaded.

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?

With output schema present, description needn't cover return format. Covers parameter behaviors and environmental constraints. Could mention existence requirement but adequate for safe operation.

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 already covers both parameters. Description adds meaningful context: 'bw get password' for term, and the reveal parameter's effect on output value and redaction triggers.

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?

Description clearly states verb 'Get' and resource 'login password' with method 'by search term', and references familiar CLI command 'bw get password'. Distinct from 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?

Provides context on when the value is null (unless reveal=true) and mentions environment variables that can override. Does not explicitly compare to alternatives but gives sufficient use-case guidance.

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