Skip to main content
Glama
BreachSpider MCP server

BreachSpider MCP server

Official

BreachSpider MCP server

A local, read only MCP server that lets AI agents (Claude Code, Claude Desktop, Cursor and any other MCP client) check industrial and IT devices against the BreachSpider device API.

Give it a vendor, product and firmware version exactly as your inventory says. It returns the CVEs that affect that version, the affected range and where it comes from, the fix, the vendor advisory and a fix plan. No CPE strings needed.

Tools

Tool

Arguments

What it does

correlate_devices

assets (list of vendor, product, version, optional asset_id); optional confirmed_only, known_exploited_only, fix_available_only, max_findings

CVEs for each device at its exact version, in priority order, with the fix plan, coverage, warnings, needs_review, a result_hash and a status_hash with its status_facts

check_changes

assets (as above, each with its stored result_hash; optional status_hash and status_facts)

Cheap repeat check: get back which devices changed, and with status_hash which ones changed status (known-exploited, lifecycle, firmware currency) and why

get_fix_plan

asset (one vendor, product, version)

Fix groups and fix plan for one device

lookup_cve

cve_id (for example CVE-2024-9137)

BreachSpider's record for one CVE, trimmed

check_windows_host

assets (list of os_product, edition_id, os_build, architecture, optional installed_kbs, installation_type, esu_enrolled, display_version, asset_id); optional max_findings

Windows hosts against Microsoft's own patch data, stored nowhere: confirmed open, cleared and needs review counts, the top open and needs review CVEs with fixed build, KB and Microsoft source, fix groups and a result_hash

submit_device_batch

assets (as for correlate_devices, up to 5,000); optional max_findings (default 10)

Queues one batch job for a long inventory and returns a job_id at once. The same list sent again within 24 hours returns the original job, so a retry never charges twice

get_device_batch

job_id; optional cursor, page_size (default 20, at most 50)

Progress while the job runs; once finished, the summary and a page of results (each the same as a correlate_devices result) with next_cursor

All are read only except submit_device_batch, which queues a job and uses the key's quota. The first four use the three endpoints a trial key can call: POST /api/v1/assets/correlate-cves, POST /api/v1/assets/correlate-cves/check and GET /api/v1/cves/{id}. check_windows_host uses POST /api/v2/assets/check-windows, which stores nothing about the hosts and needs a partner or customer key; trial keys and demo mode cannot use it. It takes at most 25 hosts per call. The batch tools use POST /api/v1/batches and GET /api/v1/batches/{id} (and /results). They need a partner or customer key with batch jobs enabled; trial keys and demo mode cannot use them. Results are kept 30 days.

Related MCP server: Security Intel MCP

Install

Requires Python 3.10 or newer. Install with pipx, which puts a breachspider-mcp command on your path.

  1. Install pipx and add its folder to your path:

    # macOS
    brew install pipx
    pipx ensurepath
    
    # Debian / Ubuntu
    sudo apt install pipx
    pipx ensurepath
    
    # Windows (PowerShell)
    py -m pip install --user pipx
    py -m pipx ensurepath
  2. Open a new terminal so the path change applies, then install:

    pipx install breachspider-mcp

Option: run with uvx instead

To run it without installing, install uv first, then use uvx breachspider-mcp wherever this README uses breachspider-mcp.

API key

Set BREACHSPIDER_API_KEY to your key. Get a free 14 day trial key at breachspider.com/developers.

With no key the server runs in demo mode: public example access only, using a short lived public demo token. Every result says so. For your own devices, start a free trial at breachspider.com/developers; for partner keys, use "Talk to us" on the same page.

The key is only read from the environment. It is never logged or returned in tool output.

Setup

Claude Code

With the key in your shell's BREACHSPIDER_API_KEY variable:

claude mcp add breachspider -e BREACHSPIDER_API_KEY="$BREACHSPIDER_API_KEY" -- breachspider-mcp

If you use uv instead of pipx, end the command with -- uvx breachspider-mcp.

Add --scope user to make it available in every project. Leave out -e ... for demo mode.

Claude Code stores the key in its MCP config, and claude mcp get breachspider prints it in plain text. Don't run that command while sharing your screen or recording, and don't paste its output anywhere.

Claude Desktop

Edit claude_desktop_config.json (Settings, Developer, Edit Config) and restart Claude Desktop:

{
  "mcpServers": {
    "breachspider": {
      "command": "/full/path/to/breachspider-mcp",
      "env": { "BREACHSPIDER_API_KEY": "bs_live_your_key" }
    }
  }
}

Use the full path from which breachspider-mcp; Claude Desktop does not read your shell path.

Cursor

Add the same block to ~/.cursor/mcp.json (all projects) or .cursor/mcp.json (one project):

{
  "mcpServers": {
    "breachspider": {
      "command": "/full/path/to/breachspider-mcp",
      "env": { "BREACHSPIDER_API_KEY": "bs_live_your_key" }
    }
  }
}

Example question

We have a Moxa EDS-518A switch on firmware V3.5. Which CVEs affect it, are any known-exploited, and what version fixes them? Cite the sources.

The agent calls correlate_devices and answers with three CVEs, all fixed by security patch 3.11.2, citing Moxa advisory MPSA-241156.

Is our Windows Server 2019 Standard on build 10.0.17763.6189 with KB5041578 installed missing any security updates? Which known-exploited CVEs are still open, and which update closes them?

The agent calls check_windows_host, reports the confirmed open count, the known-exploited CVEs first, the cumulative update that clears them, and any CVEs that need review. Nothing about the host is stored.

Privacy

Only vendor, product, version and an optional asset_id (plus result_hash, status_hash and the API's own status_facts for check_changes) are sent. Any other field is dropped before the request. Fields that look identifying (host name, IP or MAC address, user, site, location, serial number and similar) are listed in the output under privacy.dropped_identifying_fields. For check_windows_host, only the Windows host fields listed in the tools table are sent, and the same identifying-field rules apply. An asset_id that contains an IP, MAC or email address, or is a domain or fully qualified host name (for example 10.20.30.40 or sw-core-1.plant.example.com), is replaced with a neutral id such as asset-1. Tag-shaped ids such as PLC-LINE-2 or plant-a-sw01 are kept, so results map back to your own equipment.

Honest results

Each device gets an assessment sentence. An unresolved device, partial coverage, a product with no version data or an empty list is never reported as clean, and needs_review is always passed through. Agents are told to repeat this in their answer.

Trial limits and errors

API errors come back as plain messages, including TRIAL_REQUIRED, TRIAL_SCOPE, TRIAL_BATCH_LIMIT (25 devices per call on a trial), the trial limit (750 device checks; the message gives usage and when the trial ends) and TRIAL_ENDED, each with a link to the developer page and a way to talk to us. check_changes costs a tenth of a device check, so use it for repeat checks.

Every failed tool call starts with one sentence the agent acts on and ends with the API's retry guidance:

Do not retry this call; the trial has ended. Tell the user to start a new trial or ask for a partner key. TRIAL_ENDED: ...
retry_guidance: {"retryable": false, "retry_after_seconds": null, "action": "contact_us"}

retryable is true only when the same call may succeed later (then the sentence is "Retry after N seconds."); action is one of retry_later, wait_until_reset, reduce_batch, fix_input, use_different_key and contact_us. The tool descriptions tell the agent never to retry when retryable is false. The server itself never retries.

Development

python3 -m venv .venv && .venv/bin/pip install -e ".[dev]"
.venv/bin/python -m pytest                          # unit tests (mocked) plus live demo mode tests
BREACHSPIDER_SKIP_LIVE=1 .venv/bin/python -m pytest # offline only
npx @modelcontextprotocol/inspector --cli .venv/bin/breachspider-mcp --method tools/list

BREACHSPIDER_BASE_URL points the server at another deployment (default https://breachspider.com).

License

MIT, same as the BreachSpider Python SDK. See LICENSE.

Available Tools

4 tools
check_changesA
Read-onlyIdempotent

Cheap repeat check. For devices you already checked with correlate_devices, send the same vendor, product and version plus the result_hash you kept. Returns which devices changed and their new hash; only changed devices need a fresh correlate_devices call. Use this for repeat checks. Never send host names, IP or MAC addresses, user names or site names.

Inputs: assets (required).

correlate_devicesA
Read-onlyIdempotent

Find the CVEs that affect specific devices at their exact firmware or software version. Use this for any specific device and firmware. Send vendor, product and version exactly as the inventory says; no CPE is needed. Returns, per device: how it resolved, data coverage, an honest assessment, warnings, needs_review, result_hash (keep it for check_changes), the fix plan, and the top findings in priority order (known-exploited and confirmed first). Each finding gives the affected range with its source, the fix, advisory guidance and vendor advisories: cite the range source and the vendor advisory when explaining it. Report needs_review and partial coverage honestly and never call an empty, unresolved or partial result clean. Never send host names, IP or MAC addresses, user names or site names; such fields are stripped and listed under privacy.

Inputs: assets (required), max_findings, confirmed_only, fix_available_only, +1 more.

get_fix_planA
Read-onlyIdempotent

Fix plan for one device: fix groups (which update clears which CVEs) and the fix plan (the single step that clears the known-exploited CVEs, and the one that clears everything fixable). Send vendor, product and version exactly as the inventory says. Says so plainly when the device did not resolve or coverage is partial. Never send host names, IP or MAC addresses, user names or site names.

Inputs: asset (required).

lookup_cveA
Read-onlyIdempotent

Look up one CVE by id (for example CVE-2024-9137) and return BreachSpider's record, trimmed: severity, CVSS, known-exploited status, EPSS, fix status, vendor and CISA ICS advisories and links. It is not device specific; to know whether a device is affected, use correlate_devices.

Inputs: cve_id (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A4.2/5.0

    Scored across 4 tools

    Disambiguation4/5

    Each tool has a fairly distinct purpose: correlate_devices (device-to-CVE mapping), check_changes (cheap re-check via result_hash), lookup_cve (single CVE by id), and get_fix_plan (per-device remediation). The one soft overlap is that correlate_devices already returns a fix plan in its output while get_fix_plan offers a dedicated per-device plan, which could cause an agent to hesitate; descriptions mostly resolve this.

    Naming Consistency5/5

    All four tools follow a clean snake_case verb_noun pattern: correlate_devices, check_changes, lookup_cve, get_fix_plan. The convention is uniform throughout with no mixed styles or casing.

    Tool Count4/5

    Four tools is lean but appropriate for a focused device-vulnerability correlation service, and each earns its place (correlate, re-check, CVE lookup, fix plan). It is on the thin side, with no room for batch or search operations.

    Completeness4/5

    The core lifecycle is covered: correlate devices, cheaply detect changes, look up individual CVEs, and get a fix plan. Minor gaps exist—no cross-cutting CVE search (by keyword/severity) or a tool to enumerate inventory—but the primary workflows are complete and the result_hash linkage is a thoughtful touch.

    Maintenance

    ActivityMaintained
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      D
      maintenance
      Provides CVE lookup, search, and exploit intelligence from public vulnerability sources (NVD, CISA KEV, EPSS) for AI agents to produce remediation guidance without consuming LLM tokens for data fetching.
      1
      MIT
    • A
      license
      A
      quality
      B
      maintenance
      Vulnerability intelligence for AI agents that enables CVE lookup, package vulnerability checks, and dependency auditing without API keys.
      5
      MIT
    • A
      license
      A
      quality
      C
      maintenance
      Enables AI agents to search, correlate, and monitor real-time vulnerability intelligence from NVD, CISA KEV, EPSS, and MITRE ATT&CK, including CVE details, critical CVE tracking, known exploited vulnerabilities, and exploitation probability scores.
      5
      2
      MIT
    • A
      license
      A
      quality
      C
      maintenance
      Enables LLMs to access realtime CVE intelligence aggregated from NVD, CISA KEV, EPSS, GitHub advisories, PoC discovery, and Metasploit/Nuclei tooling, providing vulnerability details, exploitation signals, and prioritized triage verdicts.
      12
      92 npm
      3
      MIT