check_password

Pack: hibp · Endpoint: https://gateway.pipeworx.io/hibp/mcp

Check whether a password appears in known breach corpora. Uses k-anonymity: the password is SHA-1ed locally, only the first 5 hex chars leave the worker, and the response is filtered to match the rest. Returns pwned count (0 = not seen). The password itself is never transmitted.

Parameters

NameTypeRequiredDescription
passwordstringyesPassword to check (stays inside the worker)

Example call

Arguments

{
  "password": "correct-horse-battery-staple"
}

curl

curl -X POST https://gateway.pipeworx.io/hibp/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"check_password","arguments":{"password":"correct-horse-battery-staple"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('check_password', {
  "password": "correct-horse-battery-staple"
});

More examples

{
  "password": "MyP@ssw0rd123"
}

Response shape

Always returns: pwned, pwned_count, sha1_prefix, advice

FieldTypeDescription
pwnedbooleanWhether password appears in breach corpus
pwned_countnumberNumber of times password seen in breaches
sha1_prefixstringFirst 5 hex characters of SHA-1 hash
advicestringSecurity advice based on pwned status
Full JSON Schema
{
  "type": "object",
  "properties": {
    "pwned": {
      "type": "boolean",
      "description": "Whether password appears in breach corpus"
    },
    "pwned_count": {
      "type": "number",
      "description": "Number of times password seen in breaches"
    },
    "sha1_prefix": {
      "type": "string",
      "description": "First 5 hex characters of SHA-1 hash"
    },
    "advice": {
      "type": "string",
      "description": "Security advice based on pwned status"
    }
  },
  "required": [
    "pwned",
    "pwned_count",
    "sha1_prefix",
    "advice"
  ]
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "hibp": {
      "url": "https://gateway.pipeworx.io/hibp/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build June 27, 2026