Get Exposed

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

Beyond the readOnlyHint annotation, the description adds that not-found results return a null scalar instead of an error, and that terms follow bw lookup behavior. This provides useful behavioral context for agent invocation.

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 concise sentences front-load the main purpose, then add essential guidance on lookup behavior and not-found handling. Every sentence is valuable with 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?

Given the simple tool (one parameter, readOnly annotation, output schema exists), the description covers behavior, usage guidance, and error handling comprehensively. No additional context is needed.

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 input schema already describes the term parameter (100% coverage). The description adds value by emphasizing that exact IDs avoid ambiguous lookups, providing usage nuance beyond the schema description.

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 it checks the exposed-password count returned by 'bw get exposed' for a search term, using a specific verb and resource. It distinguishes itself from sibling tools like get_password or get_item by focusing on exposed password checking.

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 provides guidance on using exact item IDs to avoid ambiguous lookups and explains not-found behavior (null scalar vs. error). It does not explicitly mention when not to use the tool or list alternatives, but the context is clear given the tool's unique purpose.

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