Skip to main content
Glama

cyberchef_extract_entities

Extract and redact sensitive entities such as credit cards, SSNs, IPs, JWTs, and keys from logs, dumps, or configs, returning match type, offset, and masked preview.

Instructions

Enterprise DLP and forensic entity scanner. Extracts and redacts: Credit Cards (with Luhn check), US SSN, India PAN, IBAN, E.164 phone numbers, strict dual-stack IPv4 (validating 0-255 octet range; rejects 999.999.999.999) and IPv6, AWS access keys, JWTs, private keys, URLs, and emails. Returns match type, offset, and masked preview to preserve privacy.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
textYesThe unstructured text, security log, memory dump, or config file from which to extract DLP and forensic artifacts.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.4
    • changedInput schema / properties / text / description
      Previous value: -"The unstructured text, log excerpt, or payload from which to extract forensic artifacts."New value: +"The unstructured text, security log, memory dump, or config file from which to extract DLP and forensic artifacts."
  2. Changed1 schema field changedv1.0.2
    • changedInput schema / properties / text / description
      Previous value: -"Unstructured text to extract entities from"New value: +"The unstructured text, log excerpt, or payload from which to extract forensic artifacts."
  3. First observedv1.0.1

TDQS

A3.9/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses validation behavior beyond simple regex matching (Luhn check, strict 0-255 octet validation rejecting 999.999.999.999, 'strict dual-stack') and the return shape (match type, offset, masked preview). It does not mention limits on input size, performance characteristics, or whether output is reversible, which keeps it short of 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.

Conciseness4/5

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

Two sentences, front-loaded with the tool's identity before the enumeration, and the return-shape note is last. The artifact list is long but each item earns its place by defining extraction scope; slightly dense to read in one pass.

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 single-input extractor with no output schema, the description supplies the missing return contract (match type, offset, masked preview) and the detection scope. Missing only caveats on input size or handling of partial/ambiguous matches, which would be needed to fully call it.

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?

Only one parameter, and the schema's own description fully documents it (100% coverage). The description adds no syntax or format detail about the 'text' input beyond implying it is unstructured text, so baseline 3 is appropriate.

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?

States a specific verb+resource ('Extracts and redacts') and enumerates the exact artifact classes covered. This is unmistakably distinct from the sibling encode/hash/decode tools, so an agent can route to it without opening the schema.

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?

The 'Enterprise DLP and forensic entity scanner' framing implies the context of use (security logs, memory dumps) and the schema reinforces it, but there is no explicit when-to-use vs. alternative guidance and no statement of when NOT to use it. Usage is inferable, not stated.

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