Shodan MCP Server Inspector

🚀 Shodan MCP Server

A server implementing the Model Context Protocol (MCP) to provide access to Shodan's Internet scanning capabilities through a standardized interface.

🚀 Quick Start

The Shodan MCP Server implements the Model Context Protocol to expose Shodan's powerful Internet scanning and reconnaissance capabilities. It offers query capabilities for Shodan's device, service, and vulnerability databases through a consistent interface.

✨ Features

• Search Function: Query the Shodan database using advanced filters.
• DNS Resolution: Resolve domain names and obtain detailed DNS information.
• CVE Information: Retrieve specific CVE details.
• Vulnerability Retrieval: Get detailed vulnerability information related to IP addresses.
• Standardized Interface: Achieve consistent communication using the MCP protocol.
• Environment Variable Support: Securely manage API keys via environment variables.

📦 Installation

Prerequisites

• Node.js (v14 or higher)
• npm (v6 or higher)
• Shodan API key

Steps

1. Clone the repository:

   git clone https://github.com/X3r0K/Shodan-MCP-Server-Inspector.git
   cd shodan-mcp-server-Inspector
   

2. Install dependencies:

   npm install
   

3. Create a .env.local file in the root directory and add your Shodan API key:

   SHODAN_API_KEY=your_api_key_here
   

💻 Usage Examples

Start the Server

1. Build the server:

   npm run build
   

2. Start the server:

   node build/index.js
   

Available Tools

1. Search Tool
   • Query: Use Shodan's search syntax for queries.
   • Example: log4j country:US city:Atlanta
   • Return: A list of matching devices and their detailed information.
2. DNS Resolution Tool
   • Query: The domain name to be resolved.
   • Example: example.com
   • Return: DNS records and related information.
3. CVE Information Tool
   • Query: CVE identifier.
   • Example: CVE-2021-44228
   • Return: Detailed vulnerability information.

Example Queries

// Search for systems with Log4j vulnerabilities in the US
{
  "query": "log4j country:US"
}

// Resolve a domain name
{
  "query": "example.com"
}

// Get CVE information
{
  "query": "CVE-2021-44228"
}

Use the MCP Inspector Tool

You can use the MCP inspector tool to interact with the server directly:

1. Install the MCP inspector tool:

npm install -g @modelcontextprotocol/inspector

2. Connect to your server using the inspector tool:

npx @modelcontextprotocol/inspector build/index.js

The inspector tool provides the following features:

• Test all available tools.
• View tool documentation.
• Debug server responses.
• Monitor the running status.

📚 Documentation

Notes

⚠️ Important Note

Ensure the security of your API key to avoid leakage. 💡 Usage Tip

Test all functions before using them in a production environment. If you encounter any issues, refer to the official documentation or contact the support team.