Skip to main content
Glama

secret_scan

Read-only

Scan text, files, or folders to detect leaked API keys, tokens, and passwords; skips vendor directories and binaries and returns masked findings.

Instructions

Find leaked keys/tokens/passwords in text, a file or folder (skips vendor dirs, binaries). Output masked.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "secret_scan"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNo
textNo
max_findingsNo
min_confidenceNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.2

TDQS

A3.9/5.0
Behavior4/5

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

With readOnlyHint=true already covering the safety profile, the description still adds real behavioral context: it skips vendor directories and binary files, and it masks output so secrets are not echoed in plaintext. Those are non-obvious traits an agent could not derive from the annotations or schema. It does not describe scan limits or performance characteristics, which keeps it below a 5.

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?

A single dense sentence with the action front-loaded, followed by two compact parentheticals covering scope and output handling. Every clause carries information; nothing is repeated from the title or annotations.

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

Completeness4/5

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

For a read-only four-parameter scanner with no output schema, the description covers purpose, input shapes, scan exclusions, and output masking — enough to call it correctly in the common case. The gap is that two tuning parameters and the behavior when neither text nor path is given remain undocumented.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must carry parameter meaning and it only partially does: 'text, a file or folder' maps to the text and path properties. max_findings and min_confidence — including the low/medium/high confidence ladder — are left entirely unexplained, and the description does not say the parameters are all optional.

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 states a specific verb+resource ('Find leaked keys/tokens/passwords') and names the three input shapes it accepts (text, file, folder). No sibling tool in the catalog performs secret scanning, so it is trivially distinguishable, and the parenthetical scope note reinforces what it is.

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

Usage Guidelines3/5

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

Usage is only implied by the phrase 'in text, a file or folder' — the agent can infer it should pass either a text blob or a path. There is no explicit when-to-use/when-not guidance, no note about what happens if both or neither are supplied, and no mention of an alternative tool for related checks such as hash or env_compare.

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