Skip to main content
Glama

generateWordlist

Create custom password wordlists for penetration testing by combining base words with dates, patterns, and variations to generate targeted credential attack dictionaries.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
baseWordsYesList of base words (names, pets, places, etc.).
datesNoList of dates (YYYY-MM-DD, MM-DD, YYYY). Parsed for variations.
customPatternsNoList of custom patterns/symbols to prepend/append (e.g., '!', '123').
minYearNoMinimum year (YYYY) to include in variations.
maxYearNoMaximum year (YYYY) to include in variations (defaults to current year).
includeLeetNoApply basic leetspeak substitutions (a=4, e=3, etc.).
caseVariationsNoInclude variations like TitleCase, UPPERCASE.

Implementation Reference

  • src/index.ts:605-613 (registration)
    Capabilities declaration where 'generateWordlist' tool is registered for discovery by MCP clients.
    "setMode": {},
    "generateWordlist": {},
    "cancelScan": {},
    "createClientReport": {},
    "nmapScan": {},
    "runJohnTheRipper": {},
    "runHashcat": {},
    "gobuster": {},
    "nikto": {}
  • Zod schema defining input parameters and validation for the generateWordlist tool.
      baseWords: z.array(z.string()).describe("List of base words (names, pets, places, etc.)."),
      dates: z.array(z.string()).optional().describe("List of dates (YYYY-MM-DD, MM-DD, YYYY). Parsed for variations."),
      customPatterns: z.array(z.string()).optional().describe("List of custom patterns/symbols to prepend/append (e.g., '!', '123')."),
      minYear: z.number().int().optional().describe("Minimum year (YYYY) to include in variations."),
      maxYear: z.number().int().optional().describe("Maximum year (YYYY) to include in variations (defaults to current year)."),
      includeLeet: z.boolean().optional().default(false).describe("Apply basic leetspeak substitutions (a=4, e=3, etc.)."),
      caseVariations: z.boolean().optional().default(true).describe("Include variations like TitleCase, UPPERCASE.")
    }).describe(
      "Generate a custom password wordlist from target-related words. " +
      "Use this before running John the Ripper. Example: `{\"baseWords\":[\"Acme\",\"Smith\"],\"dates\":[\"1984\"],\"customPatterns\":[\"!\"]}`"
    );
  • The core handler function that implements the generateWordlist tool logic: generates variations from base words, dates, patterns; applies case and leetspeak transformations; combines prefixes/suffixes; writes unique entries to a temp file and returns path.
    server.tool("generateWordlist", generateWordlistSchema.shape, async ({ baseWords, dates, customPatterns, minYear, maxYear, includeLeet, caseVariations } /*, extra */) => {
        console.error(`Received generateWordlist:`, { baseWords: `${baseWords.length} words`, dates, customPatterns });
        await ensureTempWordlistDirExists();
        const wordlist = new Set<string>();
        const currentYear = new Date().getFullYear();
        const resolvedMinYear = minYear || currentYear - 10;
        const resolvedMaxYear = maxYear || currentYear;
        const years: string[] = [];
        for (let y = resolvedMinYear; y <= resolvedMaxYear; y++) { years.push(String(y)); years.push(String(y).slice(-2)); }
        const dateVariations: string[] = [];
        if (dates) {
            dates.forEach(dateStr => {
              const parts = dateStr.split(/[-/]/);
              if (parts.length === 3) { dateVariations.push(parts[0], parts[0].slice(-2), parts[1], parts[2], parts[1]+parts[2], parts[1]+parts[2]+parts[0], parts[1]+parts[2]+parts[0].slice(-2)); }
              else if (parts.length === 2) { dateVariations.push(parts[0], parts[1], parts[0]+parts[1]); }
              else if (parts.length === 1 && parts[0].length === 4) { dateVariations.push(parts[0], parts[0].slice(-2)); }
            });
        }
        const patterns = customPatterns || [];
        const suffixes = [...patterns, ...years, ...dateVariations];
        const prefixes = [...patterns];
    
        baseWords.forEach(base => {
            const variations = new Set<string>([base]);
            if (caseVariations) { variations.add(base.toLowerCase()); variations.add(base.toUpperCase()); variations.add(base.charAt(0).toUpperCase() + base.slice(1).toLowerCase()); }
            if (includeLeet) { const leetBase = toLeet(base); variations.add(leetBase); if (caseVariations) { /* add leet cases */ variations.add(leetBase.toLowerCase()); variations.add(leetBase.toUpperCase()); variations.add(leetBase.charAt(0).toUpperCase() + leetBase.slice(1).toLowerCase()); } }
            variations.forEach(v => {
                wordlist.add(v);
                prefixes.forEach(p => { wordlist.add(p + v); });
                suffixes.forEach(s => { wordlist.add(v + s); });
                prefixes.forEach(p => { suffixes.forEach(s => { wordlist.add(p + v + s); }); });
            });
        });
        [...years, ...dateVariations].forEach(dv => wordlist.add(dv));
    
        const filename = `wordlist_${Date.now()}.txt`;
        const filePath = path.join(TEMP_WORDLIST_DIR, filename);
        try {
          await fs.writeFile(filePath, Array.from(wordlist).join('\n'));
          return { content: [ { type: "text", text: `Generated ${wordlist.size} words.` }, { type: "text", text: `Path: ${filePath}` } ] };
        } catch (error: any) { return { content: [{ type: "text", text: `Error: ${error.message}` }], isError: true }; }
    });
  • Helper function toLeet() applies basic leetspeak substitutions, used when includeLeet is true.
    function toLeet(word: string): string {
      return word.replace(/a/gi, '4').replace(/e/gi, '3').replace(/i/gi, '1').replace(/o/gi, '0').replace(/s/gi, '5').replace(/t/gi, '7');
    }
  • Helper function to ensure the temporary wordlist directory exists before writing files.
    async function ensureTempWordlistDirExists(): Promise<void> {
      try {
        await fs.mkdir(TEMP_WORDLIST_DIR, { recursive: true });
      } catch (error) {
        console.error('Error creating temp wordlist directory:', error);
      }
    }
Behavior1/5

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

Tool has no description.

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

Conciseness1/5

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

Tool has no description.

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

Completeness1/5

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

Tool has no description.

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

Parameters1/5

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

Tool has no description.

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

Purpose1/5

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

Tool has no description.

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

Usage Guidelines1/5

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

Tool has no description.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/DMontgomery40/pentest-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server