Overview
Quickstart · Tools · HTTP · Security · Troubleshooting · Docs
mcp-shodan is an MCP server that gives AI agents access to the Shodan API and Shodan CVEDB. Hand your agent an IP, hostname, search query, product or CVE and get back what an analyst would look at: open ports and banners, TLS certificates, DNS, and vulnerability severity with EPSS and KEV status.
Note
Independent project, not affiliated with Shodan. You need your own Shodan API key.
Highlights¶
- Host reconnaissance. Open ports, products and versions, known CVEs, TLS certificate details (fingerprint, JARM, JA3S), cloud provider and banner history for any IPv4 or IPv6 address.
- Device search. Shodan query syntax with paging and facet breakdowns (country, org, port, vuln and more), plus a free count-only mode for sizing a query.
- Vulnerability intelligence. CVE details with CVSS v4/v3/v2, EPSS and KEV; CVEs by product or CPE, sortable by EPSS. CVEDB is free and doesn't spend query credits.
- DNS. Subdomains and DNS records for a domain, and forward and reverse lookups for many names or IPs in one call.
- Credit-aware. Free tools are marked as free, and
api_infoshows the credits left on your plan. - Two transports. stdio for desktop clients, HTTP streaming for a shared service.
- Tested. Unit tests with a mocked Shodan API run in CI on Node 20, 22 and 24.
How it works¶
flowchart LR
A["AI agent<br/>(Claude, Codex, Gemini, VS Code)"] -->|"MCP over stdio or HTTP"| S["mcp-shodan"]
S -->|"validate input,<br/>HTTPS + API key"| SH["Shodan REST API"]
S -->|"HTTPS, no key"| C["Shodan CVEDB"]
SH -->|"JSON"| S
C -->|"JSON"| S
S -->|"structured JSON text"| A
Quickstart¶
Requirements: Node.js 20 or newer and a Shodan API key.
# Claude Code
claude mcp add --transport stdio --env SHODAN_API_KEY=your-key shodan -- npx -y @burtthecoder/mcp-shodan
# Codex CLI
codex mcp add shodan --env SHODAN_API_KEY=your-key -- npx -y @burtthecoder/mcp-shodan
# Gemini CLI
gemini mcp add -e SHODAN_API_KEY=your-key shodan npx -y @burtthecoder/mcp-shodan
For Claude Desktop, VS Code, Smithery and running from source, see Connect a client.
Then ask your agent: "What is exposed on 8.8.8.8, and is CVE-2021-44228 in the KEV catalog?" More prompts are in example workflows.
Tools¶
Eleven read-only tools. Full parameters are in the tool reference.
| Group | Tool | What it does |
|---|---|---|
| Network | ip_lookup |
Ports, products, CVEs, TLS, location and cloud for one IP, optionally with banner history |
shodan_search |
Search devices with Shodan query syntax, with paging and facet breakdowns | |
shodan_count |
Total matches and facet breakdowns for a query, without results (free) | |
domain_info |
Subdomains and DNS records for a domain | |
dns_lookup |
Resolve hostnames to IPs, in batch | |
reverse_dns_lookup |
Hostnames for IPs, in batch | |
| Vulnerabilities (CVEDB) | cve_lookup |
CVSS, EPSS, KEV, references and affected CPEs for one CVE |
cpe_lookup |
CPE 2.3 identifiers for a product name | |
cves_by_product |
CVEs for a product or CPE, filterable by KEV and date, sortable by EPSS | |
| Helpers | search_filters |
Valid search filter and facet names |
api_info |
Your plan and remaining query and scan credits |
Tip
Credits: filtered shodan_search queries cost one query credit (plus one per extra page) and domain_info costs one per call. shodan_count, ip_lookup, dns_lookup, reverse_dns_lookup, search_filters, api_info and the CVEDB tools are free.
HTTP streaming transport¶
stdio is the default. Set MCP_TRANSPORT=httpStream to run a standalone HTTP service:
MCP_TRANSPORT=httpStream MCP_PORT=3000 SHODAN_API_KEY=your-key node build/index.js
docker build -t mcp-shodan .
docker run -p 127.0.0.1:3000:3000 -e SHODAN_API_KEY=your-key -e MCP_TRANSPORT=httpStream mcp-shodan
A health check is served at /health.
Environment variables¶
| Variable | Default | Description |
|---|---|---|
SHODAN_API_KEY |
(required) | Your Shodan API key |
MCP_TRANSPORT |
stdio |
stdio or httpStream |
MCP_HOST |
localhost |
Bind address (httpStream only). The Docker image sets 0.0.0.0 |
MCP_PORT |
3000 |
HTTP port (httpStream only) |
MCP_ENDPOINT |
/mcp |
HTTP endpoint path (httpStream only) |
Security¶
Warning
The HTTP transport has no authentication. Keep the port on localhost or behind an authenticating reverse proxy, or anyone who can reach it can spend your query credits.
- Tool arguments are validated with zod schemas before any request is built. IPs must be valid IPv4 or IPv6, domains valid hostnames, facets
name[:count]lists, and CVE IDs must matchCVE-YYYY-NNNN. - The API key is read from the environment and sent only to
api.shodan.io. CVEDB calls carry no key. - What you look up is sent to Shodan.
Report vulnerabilities privately; see SECURITY.md.
Troubleshooting¶
- 401 / invalid key: check for spaces or quotes around the key, then restart the client.
curl "https://api.shodan.io/api-info?key=$SHODAN_API_KEY"shows your plan and credits. - 403 on
shodan_search: search filters need a membership or paid API plan. Runapi_infoto see your plan and credits. - 429: Shodan allows about one request per second. Retry after a moment.
More in the troubleshooting guide.
Development¶
git clone https://github.com/w0h1v/mcp-shodan && cd mcp-shodan
npm ci
npm test # build + unit tests, no key or network
npx fastmcp dev build/index.js # try tools interactively (needs SHODAN_API_KEY)
See CONTRIBUTING.md and the changelog.
License¶
MIT. See LICENSE.