@burtthecoder/mcp-shodan 1.0.6 → 1.0.8

package/README.md

@@ -1,13 +1,15 @@
 # Shodan MCP Server
 
-A Model Context Protocol (MCP) server for querying the [Shodan API](https://shodan.io). This server provides tools for IP lookups, device searches, DNS lookups, vulnerability queries, and more. It is designed to integrate seamlessly with MCP-compatible applications like [Claude Desktop](https://claude.ai).
+A Model Context Protocol (MCP) server for querying the [Shodan API](https://shodan.io) and [Shodan CVEDB](https://cvedb.shodan.io). This server provides tools for IP lookups, device searches, DNS lookups, vulnerability queries, CPE lookups, and more. It is designed to integrate seamlessly with MCP-compatible applications like [Claude Desktop](https://claude.ai).
 
 ## Features
 
 - **IP Lookup**: Retrieve detailed information about an IP address
 - **Search**: Search for devices on Shodan matching specific queries
 - **Ports**: Get a list of ports that Shodan is scanning
-- **Vulnerabilities**: Fetch information about known vulnerabilities (CVE)
+- **CVE Lookup**: Fetch detailed information about specific CVEs using Shodan's CVEDB
+- **CPE Lookup**: Search for Common Platform Enumeration (CPE) entries by product name
+- **CVEs by Product**: Search for all CVEs affecting a specific product or CPE
 - **DNS Lookup**: Resolve hostnames to IP addresses
 
 ## Tools
@@ -25,13 +27,54 @@ A Model Context Protocol (MCP) server for querying the [Shodan API](https://shod
   * `query` (required): Shodan search query
   * `max_results` (optional, default: 10): Number of results to return
 
-### 3. Vulnerabilities Tool
-- Name: `vulnerabilities`
-- Description: Fetch information about known vulnerabilities
+### 3. CVE Lookup Tool
+- Name: `cve_lookup`
+- Description: Fetch detailed information about CVEs using Shodan's CVEDB
 - Parameters:
-  * `cve` (required): CVE identifier
-
-### 4. DNS Lookup Tool
+  * `cve` (required): CVE identifier in format CVE-YYYY-NNNNN (e.g., CVE-2021-44228)
+- Returns:
+  * CVE details including:
+    - CVSS v2 and v3 scores
+    - EPSS score and ranking
+    - KEV status
+    - Proposed action
+    - Ransomware campaign information
+    - Affected products (CPEs)
+    - References
+
+### 4. CPE Lookup Tool
+- Name: `cpe_lookup`
+- Description: Search for Common Platform Enumeration (CPE) entries by product name
+- Parameters:
+  * `product` (required): Name of the product to search for
+  * `count` (optional, default: false): If true, returns only the count of matching CPEs
+  * `skip` (optional, default: 0): Number of CPEs to skip (for pagination)
+  * `limit` (optional, default: 1000): Maximum number of CPEs to return
+- Returns:
+  * When count is true: Total number of matching CPEs
+  * When count is false: List of CPEs with pagination details
+
+### 5. CVEs by Product Tool
+- Name: `cves_by_product`
+- Description: Search for CVEs affecting a specific product or CPE
+- Parameters:
+  * `cpe23` (optional): CPE 2.3 identifier (format: cpe:2.3:part:vendor:product:version)
+  * `product` (optional): Name of the product to search for CVEs
+  * `count` (optional, default: false): If true, returns only the count of matching CVEs
+  * `is_kev` (optional, default: false): If true, returns only CVEs with KEV flag set
+  * `sort_by_epss` (optional, default: false): If true, sorts CVEs by EPSS score
+  * `skip` (optional, default: 0): Number of CVEs to skip (for pagination)
+  * `limit` (optional, default: 1000): Maximum number of CVEs to return
+  * `start_date` (optional): Start date for filtering CVEs (format: YYYY-MM-DDTHH:MM:SS)
+  * `end_date` (optional): End date for filtering CVEs (format: YYYY-MM-DDTHH:MM:SS)
+- Notes:
+  * Must provide either cpe23 or product, but not both
+  * Date filtering uses published time of CVEs
+- Returns:
+  * When count is true: Total number of matching CVEs
+  * When count is false: List of CVEs with pagination details and query parameters
+
+### 6. DNS Lookup Tool
 - Name: `dns_lookup`
 - Description: Resolve hostnames to IP addresses
 - Parameters:
@@ -91,8 +134,8 @@ There are two ways to configure the Shodan MCP server in Claude Desktop:
 {
   "mcpServers": {
     "shodan-mcp": {
-      "command": "npx",
-      "args": ["@burtthecoder/mcp-shodan"],
+      "command": "npm",
+      "args": ["exec", "@burtthecoder/mcp-shodan"],
       "env": {
         "SHODAN_API_KEY": "your_shodan_api_key",
         "DEBUG": "*"
@@ -102,7 +145,7 @@ There are two ways to configure the Shodan MCP server in Claude Desktop:
 }
 ```
 
-The npx method automatically downloads and runs the latest version of the package from npm.
+The npm exec method automatically downloads and runs the latest version of the package from npm.
 
 Configuration file location:
 
@@ -133,9 +176,15 @@ The server includes comprehensive error handling for:
 - Rate limiting
 - Network errors
 - Invalid input parameters
+- Invalid CVE formats
+- Invalid CPE lookup parameters
+- Invalid date formats
+- Mutually exclusive parameter validation
 
 ## Version History
 
+- v1.0.7: Added CVEs by Product search functionality and renamed vulnerabilities tool to cve_lookup
+- v1.0.6: Added CVEDB integration for enhanced CVE lookups and CPE search functionality
 - v1.0.0: Initial release with core functionality
 
 ## Contributing
@@ -148,4 +197,4 @@ The server includes comprehensive error handling for:
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/build/index.js

@@ -41,7 +41,7 @@ const SearchArgsSchema = z.object({
         .default(10)
         .describe("Maximum results to return."),
 });
-const VulnerabilitiesArgsSchema = z.object({
+const CVELookupArgsSchema = z.object({
     cve: z.string()
         .regex(/^CVE-\d{4}-\d{4,}$/i, "Must be a valid CVE ID format (e.g., CVE-2021-44228)")
         .describe("The CVE identifier to query (format: CVE-YYYY-NNNNN)."),
@@ -49,6 +49,23 @@ const VulnerabilitiesArgsSchema = z.object({
 const DnsLookupArgsSchema = z.object({
     hostnames: z.array(z.string()).describe("List of hostnames to resolve."),
 });
+const CpeLookupArgsSchema = z.object({
+    product: z.string().describe("The name of the product to search for CPEs."),
+    count: z.boolean().optional().default(false).describe("If true, returns only the count of matching CPEs."),
+    skip: z.number().optional().default(0).describe("Number of CPEs to skip (for pagination)."),
+    limit: z.number().optional().default(1000).describe("Maximum number of CPEs to return (max 1000)."),
+});
+const CVEsByProductArgsSchema = z.object({
+    cpe23: z.string().optional().describe("The CPE version 2.3 identifier (format: cpe:2.3:part:vendor:product:version)."),
+    product: z.string().optional().describe("The name of the product to search for CVEs."),
+    count: z.boolean().optional().default(false).describe("If true, returns only the count of matching CVEs."),
+    is_kev: z.boolean().optional().default(false).describe("If true, returns only CVEs with the KEV flag set."),
+    sort_by_epss: z.boolean().optional().default(false).describe("If true, sorts CVEs by EPSS score in descending order."),
+    skip: z.number().optional().default(0).describe("Number of CVEs to skip (for pagination)."),
+    limit: z.number().optional().default(1000).describe("Maximum number of CVEs to return (max 1000)."),
+    start_date: z.string().optional().describe("Start date for filtering CVEs (format: YYYY-MM-DDTHH:MM:SS)."),
+    end_date: z.string().optional().describe("End date for filtering CVEs (format: YYYY-MM-DDTHH:MM:SS).")
+}).refine(data => !(data.cpe23 && data.product), { message: "Cannot specify both cpe23 and product. Use only one." }).refine(data => data.cpe23 || data.product, { message: "Must specify either cpe23 or product." });
 // Helper Function to Query Shodan API
 async function queryShodan(endpoint, params) {
     try {
@@ -81,6 +98,34 @@ async function queryCVEDB(cveId) {
         throw new Error(`CVEDB API error: ${error.message}`);
     }
 }
+// Helper Function for CPE lookups using CVEDB
+async function queryCPEDB(params) {
+    try {
+        logToFile(`Querying CVEDB for CPEs with params: ${JSON.stringify(params)}`);
+        const response = await axios.get(`${CVEDB_API_URL}/cpes`, { params });
+        return response.data;
+    }
+    catch (error) {
+        if (error.response?.status === 422) {
+            throw new Error(`Invalid parameters: ${error.response.data?.detail || error.message}`);
+        }
+        throw new Error(`CVEDB API error: ${error.message}`);
+    }
+}
+// Helper Function for CVEs by product/CPE lookups using CVEDB
+async function queryCVEsByProduct(params) {
+    try {
+        logToFile(`Querying CVEDB for CVEs with params: ${JSON.stringify(params)}`);
+        const response = await axios.get(`${CVEDB_API_URL}/cves`, { params });
+        return response.data;
+    }
+    catch (error) {
+        if (error.response?.status === 422) {
+            throw new Error(`Invalid parameters: ${error.response.data?.detail || error.message}`);
+        }
+        throw new Error(`CVEDB API error: ${error.message}`);
+    }
+}
 // Server Setup
 const server = new Server({
     name: "shodan-mcp",
@@ -106,7 +151,7 @@ server.setRequestHandler(InitializeRequestSchema, async (request) => {
             name: "shodan-mcp",
             version: "1.0.0",
         },
-        instructions: "This server provides tools for querying Shodan, including IP lookups, searches, and vulnerabilities. For CVE lookups, use the format CVE-YYYY-NNNNN (e.g., CVE-2021-44228).",
+        instructions: "This server provides tools for querying Shodan, including IP lookups, searches, CVE lookups, CPE lookups, and CVE searches by product/CPE.",
     };
 });
 // Register Tools
@@ -123,15 +168,25 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
             inputSchema: zodToJsonSchema(SearchArgsSchema),
         },
         {
-            name: "vulnerabilities",
+            name: "cve_lookup",
             description: "Retrieve vulnerability information for a CVE. Use format: CVE-YYYY-NNNNN (e.g., CVE-2021-44228)",
-            inputSchema: zodToJsonSchema(VulnerabilitiesArgsSchema),
+            inputSchema: zodToJsonSchema(CVELookupArgsSchema),
         },
         {
             name: "dns_lookup",
             description: "Perform DNS lookups using Shodan.",
             inputSchema: zodToJsonSchema(DnsLookupArgsSchema),
         },
+        {
+            name: "cpe_lookup",
+            description: "Search for Common Platform Enumeration (CPE) entries by product name.",
+            inputSchema: zodToJsonSchema(CpeLookupArgsSchema),
+        },
+        {
+            name: "cves_by_product",
+            description: "Search for CVEs affecting a specific product or CPE. Provide either product name or CPE 2.3 identifier.",
+            inputSchema: zodToJsonSchema(CVEsByProductArgsSchema),
+        },
     ];
     logToFile("Registered tools.");
     return { tools };
@@ -175,12 +230,12 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
                     ],
                 };
             }
-            case "vulnerabilities": {
-                const parsedVulnArgs = VulnerabilitiesArgsSchema.safeParse(args);
-                if (!parsedVulnArgs.success) {
+            case "cve_lookup": {
+                const parsedCveArgs = CVELookupArgsSchema.safeParse(args);
+                if (!parsedCveArgs.success) {
                     throw new Error("Invalid CVE format. Please use format: CVE-YYYY-NNNNN (e.g., CVE-2021-44228)");
                 }
-                const cveId = parsedVulnArgs.data.cve.toUpperCase();
+                const cveId = parsedCveArgs.data.cve.toUpperCase();
                 logToFile(`Looking up CVE: ${cveId}`);
                 try {
                     const result = await queryCVEDB(cveId);
@@ -241,6 +296,103 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
                     ],
                 };
             }
+            case "cpe_lookup": {
+                const parsedCpeArgs = CpeLookupArgsSchema.safeParse(args);
+                if (!parsedCpeArgs.success) {
+                    throw new Error("Invalid cpe_lookup arguments");
+                }
+                try {
+                    const result = await queryCPEDB({
+                        product: parsedCpeArgs.data.product,
+                        count: parsedCpeArgs.data.count,
+                        skip: parsedCpeArgs.data.skip,
+                        limit: parsedCpeArgs.data.limit
+                    });
+                    // Format the response based on whether it's a count request or full CPE list
+                    const formattedResult = parsedCpeArgs.data.count
+                        ? { total_cpes: result.total }
+                        : {
+                            cpes: result.cpes,
+                            skip: parsedCpeArgs.data.skip,
+                            limit: parsedCpeArgs.data.limit,
+                            total_returned: result.cpes.length
+                        };
+                    return {
+                        content: [
+                            {
+                                type: "text",
+                                text: JSON.stringify(formattedResult, null, 2),
+                            },
+                        ],
+                    };
+                }
+                catch (error) {
+                    return {
+                        content: [
+                            {
+                                type: "text",
+                                text: error.message,
+                            },
+                        ],
+                        isError: true,
+                    };
+                }
+            }
+            case "cves_by_product": {
+                const parsedArgs = CVEsByProductArgsSchema.safeParse(args);
+                if (!parsedArgs.success) {
+                    throw new Error("Invalid arguments. Must provide either cpe23 or product name, but not both.");
+                }
+                try {
+                    const result = await queryCVEsByProduct({
+                        cpe23: parsedArgs.data.cpe23,
+                        product: parsedArgs.data.product,
+                        count: parsedArgs.data.count,
+                        is_kev: parsedArgs.data.is_kev,
+                        sort_by_epss: parsedArgs.data.sort_by_epss,
+                        skip: parsedArgs.data.skip,
+                        limit: parsedArgs.data.limit,
+                        start_date: parsedArgs.data.start_date,
+                        end_date: parsedArgs.data.end_date
+                    });
+                    // Format the response based on whether it's a count request or full CVE list
+                    const formattedResult = parsedArgs.data.count
+                        ? { total_cves: result.total }
+                        : {
+                            cves: result.cves,
+                            skip: parsedArgs.data.skip,
+                            limit: parsedArgs.data.limit,
+                            total_returned: result.cves.length,
+                            query_params: {
+                                cpe23: parsedArgs.data.cpe23,
+                                product: parsedArgs.data.product,
+                                is_kev: parsedArgs.data.is_kev,
+                                sort_by_epss: parsedArgs.data.sort_by_epss,
+                                start_date: parsedArgs.data.start_date,
+                                end_date: parsedArgs.data.end_date
+                            }
+                        };
+                    return {
+                        content: [
+                            {
+                                type: "text",
+                                text: JSON.stringify(formattedResult, null, 2),
+                            },
+                        ],
+                    };
+                }
+                catch (error) {
+                    return {
+                        content: [
+                            {
+                                type: "text",
+                                text: error.message,
+                            },
+                        ],
+                        isError: true,
+                    };
+                }
+            }
             default:
                 throw new Error(`Unknown tool: ${name}`);
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@burtthecoder/mcp-shodan",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "A Model Context Protocol server for Shodan API queries.",
   "main": "./build/index.js",
   "bin": {