Ways to connect¶
All five ways in use the same engine and give the same answer and the same hashes for the same device. Pick by where your inventory lives and who asks the question.
| Web app | API | Python SDK | MCP server (local) | Hosted MCP | |
|---|---|---|---|---|---|
| Who uses it | People in your team | Your systems | Your Python scripts | An assistant on your machine | An assistant that connects by URL |
| Where the inventory lives | In BreachSpider | In your system | In your system | In your files or prompt | In your prompt |
| Stores your devices | Yes | Only the stored endpoints | Only the stored endpoints | No | No |
| How it signs in | Email link (and two-factor) | API key | API key | API key in an environment variable | Your BreachSpider email, approved in the browser |
| Install | None | None | pip install breachspider | pipx install breachspider-mcp | None |
Web app¶
Sign in at breachspider.com/login; the app is at breachspider.com/app. Start with Getting started.
API¶
Base URL https://breachspider.com/api/v1 (and /api/v2 for Windows). Send your key as a bearer token:
export BREACHSPIDER_API_KEY=bs_live_...
curl -X POST https://breachspider.com/api/v1/assets/correlate-cves \
-H "Authorization: Bearer $BREACHSPIDER_API_KEY" \
-H "Content-Type: application/json" \
-d '{"assets": [{"asset_id": "SW-01", "vendor": "Moxa", "product": "EDS-518A", "version": "V3.5"}]}'
Where keys come from:
- Customers: make a key on Integrations in the web app. It is shown once.
- Developers trying it out: a free 14 day trial key at breachspider.com/developers: 750 device checks, 25 devices per call, the device check, the change check and single CVE lookups.
- Partners: keys issued by BreachSpider. Ask through "Talk to us" on the developers page.
Reference: API overview, Authentication and access.
Python SDK¶
pip install breachspider
import os
import breachspider
bs = breachspider.Client(os.environ["BREACHSPIDER_API_KEY"])
resp = bs.correlate.correlate([{"asset_id": "SW-01", "vendor": "Moxa", "product": "EDS-518A", "version": "V3.5"}])
result = resp.results[0]
for cve in result.cves:
print(cve.priority_rank, cve.cve_id, cve.priority_reason)
print(result.fix_plan)
No key yet: breachspider.Client.demo() gives a read-only demo token for public example data. Guide: Python SDK.
MCP server (local)¶
For Claude Code, Claude Desktop, Cursor and other MCP clients on your machine:
pipx install breachspider-mcp
claude mcp add breachspider -e BREACHSPIDER_API_KEY="$BREACHSPIDER_API_KEY" -- breachspider-mcp
Only vendor, product, version and a neutral asset id leave your machine. Without a key it runs in demo mode on public example data. Guide: MCP server (local).
Hosted MCP¶
For assistants that connect to a remote MCP server by URL (tested with Claude and ChatGPT):
https://mcp.breachspider.com/mcp
You sign in with your BreachSpider email and approve what the assistant may do. No key to copy. Connecting by URL is turned on per organization; Integrations shows whether it is open for yours and lists every connected app so you can revoke it. Guide: Hosted MCP.