Skip to main content
Glama

scan_local

Read-only

Scan any local filesystem path for leaked secrets like API keys and passwords. Detects exposures without sending data externally and returns redacted findings.

Instructions

Scan a local filesystem path for leaked secrets (API keys, tokens, passwords). Fully local — no network calls, no data sent to any external service. Never modifies scanned files. No authentication required. Returns redacted findings — raw secret values are never included in the output.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
scan_pathYesAbsolute or relative path to scan
regex_fileNoPath to custom regex YAML file (optional)
report_formatNoOutput report formatn0s1
show_matched_secret_on_logsNoInclude redacted secret snippets in logs (default: false)
report_uuidNoUUID to assign to the scan report; overrides the auto-generated one

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
report_uuidYes
statusYes
summaryYes
findingsNo
next_cursorNo
usageYes
ai_analysis_statusNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.1.6
    • changedInput schema / properties / show_matched_secret_on_logs / description
      Previous value: -"Show matched secret values in reports and logs (default: false)"New value: +"Include redacted secret snippets in logs (default: false)"
  2. Changed3 schema fields changedv1.1.4
    • addedInput schema / properties / report_format / description
      Added value: +"Output report format"
    • addedInput schema / properties / report_uuid
      Added value: +{
      +  "description": "UUID to assign to the scan report; overrides the auto-generated one",
      +  "type": "string"
      +}
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$defs": {
      +    "Finding": {
      +      "description": "A single redacted secret finding.",
      +      "properties": {
      +        "file": {
      +          "title": "File",
      +          "type": "string"
      +        },
      +        "line": {
      +          "anyOf": [
      +            {
      +              "type": "integer"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ],
      +          "default": null,
      +          "title": "Line"
      +        },
      +        "redacted_match": {
      +          "title": "Redacted Match",
      +          "type": "string"
      +        },
      +        "severity": {
      +          "$ref": "#/$defs/Severity"
      +        },
      +        "type": {
      +          "title": "Type",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "file",
      +        "type",
      +        "severity",
      +        "redacted_match"
      +      ],
      +      "title": "Finding",
      +      "type": "object"
      +    },
      +    "ScanSummary": {
      +      "description": "Aggregate counts from a completed scan.",
      +      "properties": {
      +        "by_severity": {
      +          "additionalProperties": {
      +            "type": "integer"
      +          },
      +          "propertyNames": {
      +            "$ref": "#/$defs/Severity"
      +          },
      +          "title": "By Severity",
      +          "type": "object"
      +        },
      +        "by_type": {
      +          "additionalProperties": {
      +            "type": "integer"
      +          },
      +          "title": "By Type",
      +          "type": "object"
      +        },
      +        "total_findings": {
      +          "title": "Total Findings",
      +          "type": "integer"
      +        }
      +      },
      +      "required": [
      +        "total_findings",
      +        "by_severity",
      +        "by_type"
      +      ],
      +      "title": "ScanSummary",
      +      "type": "object"
      +    },
      +    "Severity": {
      +      "enum": [
      +        "info",
      +        "low",
      +        "medium",
      +        "high",
      +        "critical"
      +      ],
      +      "title": "Severity",
      +      "type": "string"
      +    },
      +    "Usage": {
      +      "description": "Token-usage accounting block.",
      +      "properties": {
      +        "savings_pct": {
      +          "title": "Savings Pct",
      +          "type": "number"
      +        },
      +        "tokens_in_estimate": {
      +          "title": "Tokens In Estimate",
      +          "type": "integer"
      +        },
      +        "tokens_out_actual": {
      +          "title": "Tokens Out Actual",
      +          "type": "integer"
      +        },
      +        "tokens_saved_estimate": {
      +          "title": "Tokens Saved Estimate",
      +          "type": "integer"
      +        }
      +      },
      +      "required": [
      +        "tokens_in_estimate",
      +        "tokens_out_actual",
      +        "tokens_saved_estimate",
      +        "savings_pct"
      +      ],
      +      "title": "Usage",
      +      "type": "object"
      +    }
      +  },
      +  "description": "Full result returned by every scan_* tool.",
      +  "properties": {
      +    "ai_analysis_status": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Ai Analysis Status"
      +    },
      +    "findings": {
      +      "anyOf": [
      +        {
      +          "items": {
      +            "$ref": "#/$defs/Finding"
      +          },
      +          "type": "array"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Findings"
      +    },
      +    "next_cursor": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "title": "Next Cursor"
      +    },
      +    "report_uuid": {
      +      "title": "Report Uuid",
      +      "type": "string"
      +    },
      +    "status": {
      +      "enum": [
      +        "pending",
      +        "running",
      +        "complete",
      +        "failed"
      +      ],
      +      "title": "Status",
      +      "type": "string"
      +    },
      +    "summary": {
      +      "$ref": "#/$defs/ScanSummary"
      +    },
      +    "usage": {
      +      "$ref": "#/$defs/Usage"
      +    }
      +  },
      +  "required": [
      +    "report_uuid",
      +    "status",
      +    "summary",
      +    "usage"
      +  ],
      +  "title": "ScanResult",
      +  "type": "object"
      +}
  3. First observedv1.1.1

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false. The description adds critical behavioral details beyond annotations: 'Never modifies scanned files', 'No authentication required', and 'Returns redacted findings — raw secret values are never included'. No contradictions.

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?

Three sentences covering purpose, locality, safety, and output redaction. Every sentence adds value. No redundant or unnecessary text. Front-loaded with the primary action.

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?

The description effectively covers core behavior and safety. With an output schema available, return values are partially explained (redacted findings). It omits details about optional parameters like regex_file or show_matched_secret_on_logs, but these are in the schema. Adequate for a moderately complex tool.

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

Parameters3/5

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

Schema description coverage is 100%, so baseline is 3. The description does not elaborate on individual parameters beyond what the schema provides. However, it summarizes the overall behavior (scan path, report format, etc.) without adding new semantic meaning for parameters.

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 scans a local filesystem for leaked secrets, listing specific secret types. It distinguishes itself from sibling tools that scan remote platforms (e.g., scan_github) by emphasizing 'Fully local — no network calls'. The action and resource are both specific and unique.

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 provides clear context: when to use (local filesystem scanning), what it doesn't do (no network calls, no data sent externally), and prerequisites (no authentication required). It lacks an explicit comparison to siblings, but the 'local' distinction is evident from sibling names.

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