Get Notes

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

Discloses that notes are secret output with null value unless reveal=true and NOREVEAL is inactive, adding important behavioral context beyond the readOnlyHint annotation. Does not mention permissions or other traits.

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?

Three sentences conveying necessary info, but the first sentence is awkwardly phrased ('matched by bw get notes'). Adequately concise but could be clearer.

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 key behaviors (secret output, ambiguity) given the tool's simplicity (2 params, output schema exists). Does not describe output structure, but schema handles that.

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?

Adds value by clarifying term ambiguity and preference for exact IDs, complementing the schema description. The reveal parameter explanation aligns with schema but is slightly redundant.

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 retrieves item notes for a search term using 'bw get notes', specifying the verb and resource. However, it does not explicitly differentiate from sibling tools like keychain_get_item, which may also retrieve notes.

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 guidance on ambiguous terms by recommending exact item IDs when possible, but lacks explicit when-to-use or when-not-to-use compared to alternatives. No comparison to sibling tools.

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