Skip to main content
Glama

Get Exposed

keychain_get_exposed
Read-only

Check how many times a vault item's password has been exposed by searching with a term or exact item ID. Returns the exposed count, or null if no match is found.

Instructions

Check the exposed-password count returned by bw get exposed for a search term. Terms follow bw lookup behavior and may be ambiguous; use an exact item id or precise selector when possible. Not-found results return a null scalar value instead of a thrown not-found error.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
termYesSearch term or exact item id; exact ids avoid ambiguous bw lookups.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.2.35
    • removedOutput schema / properties / result / properties / value / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / result / properties / value / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  2. Changed2 schema fields changedv0.2.19
    • addedInput schema / properties / term / description
      Added value: +"Search term or exact item id; exact ids avoid ambiguous bw lookups."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "result": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "kind": {
      +          "const": "exposed",
      +          "type": "string"
      +        },
      +        "revealed": {
      +          "type": "boolean"
      +        },
      +        "value": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        }
      +      },
      +      "required": [
      +        "kind",
      +        "value",
      +        "revealed"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "result"
      +  ],
      +  "type": "object"
      +}
  3. Addedv0.1.20

TDQS

A4.5/5.0
Behavior4/5

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

The readOnlyHint annotation already signals this is a safe read operation. The description adds valuable behavioral detail beyond this: not-found results return a null scalar rather than throwing an error, and lookups may be ambiguous. This is useful context for agent error handling.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three sentences with no fluff. The primary action is stated first, followed by practical usage guidance and error behavior, each sentence earning its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter read-only tool with an output schema, the description covers the purpose, lookup semantics, ambiguity caveat, and not-found behavior. Nothing critical is missing for an agent to invoke this tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents the 'term' parameter. The description adds meaning by explaining that terms follow bw lookup behavior and may be ambiguous, and by recommending exact ids to avoid ambiguity, which goes beyond the schema's bare definition.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool checks the exposed-password count returned by 'bw get exposed' for a search term. This names a specific verb, resource, and result type, and the operation is distinct from sibling keychain getters.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives clear usage context: it checks exposed-password counts and warns that terms follow bw lookup behavior and may be ambiguous, recommending exact item ids or precise selectors. It does not explicitly name alternatives or exclusion criteria, but the tool's purpose is specific enough that the guidance is sufficient.

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