GitHub - Hexix23/shodan-mcp (original) (raw)

🌐 SHODAN-MCP

🔍 Overview

SHODAN-MCP is a powerful interface to the Shodan API, designed to simplify interaction with the world's first search engine for Internet-connected devices. It provides a comprehensive set of tools for security researchers, penetration testers, and cybersecurity professionals to explore, analyze, and monitor the global internet landscape.

"The more systems you can access, the more power you have."

✨ Key Features

🔎 Search & Discovery

• Advanced Search: Query the Shodan database using powerful filtering capabilities and multiple parameters
• Result Analysis: Detailed breakdowns of search results with geographic distribution and organization insights
• Count Function: Get total numbers and statistical breakdowns without consuming API credits

📡 Host Intelligence

• Detailed Host Information: Comprehensive data about any IP address including all services, banners and configurations
• Port Scanning: View all open ports and running services on target systems
• Banner Grabbing: Access complete service banners and headers for in-depth analysis

🔒 Security Research

• Vulnerability Discovery: Find devices affected by specific CVEs or with particular vulnerabilities
• CVE Information: Get detailed intelligence on Common Vulnerabilities and Exposures
• Exploitation Risk Assessment: Evaluate threats with CVSS scores and EPSS exploitation likelihood metrics

🌍 Network Mapping

• DNS Intelligence: Retrieve comprehensive DNS information and subdomain discovery
• Domain Insights: Analyze domain infrastructure and associated services
• Reverse DNS: Map IP addresses to hostnames for network enumeration

🛠️ Installation & Setup

Prerequisites

• Python 3.8 or higher
• Shodan API key (Get one here)
• pip or uv for dependency management

Basic Installation

Clone the repository

git clone https://github.com/yourusername/shodan-mcp.git cd shodan-mcp

Install dependencies

pip install -r requirements.txt

Set up your Shodan API key

echo "SHODAN_API_KEY=your_api_key_here" > shodan-mcp-server/.env

Integration Options

SHODAN-MCP can be integrated with various AI and development environments:

🤖 Claude Integration

Claude can interact with SHODAN-MCP using the MCP protocol:

1. In Claude Desktop, go to Settings → Developer → Edit Config
2. Edit the claude_desktop_config.json file and add the following configuration:
   "mcpServers": {
   "shodan": {
   "command": "/path/to/uv",
   "args": [
   "--directory",
   "/path/to/shodan-mcp/shodan-mcp-server",
   "run",
   "shodan_mcp.py"
   ]
   }
   }
3. Replace /path/to/uv with your actual path to the uv executable (e.g., ~/.local/bin/uv on macOS/Linux)
4. Replace /path/to/shodan-mcp with the actual path to your shodan-mcp project directory
5. Save the configuration and restart Claude
6. Now you can ask Claude to use Shodan tools directly in your conversations

🖥️ Cursor IDE Integration

Cursor seamlessly integrates with SHODAN-MCP through the MCP configuration file:

1. The MCP configuration file is located at ~/.cursor/mcp.json (macOS/Linux)
2. Add the following configuration to your mcp.json:
   {
   "mcpServers": {
   "shodan": {
   "command": "/path/to/uv",
   "args": [
   "--directory",
   "/path/to/shodan-mcp/shodan-mcp-server",
   "run",
   "shodan_mcp.py"
   ],
   "env": {}
   }
   }
   }
3. Replace /path/to/uv with your actual path to the uv executable (e.g., ~/.local/bin/uv on macOS/Linux)
4. Replace /path/to/shodan-mcp with the actual path to your shodan-mcp project directory
5. Save the configuration and restart Cursor
6. The Shodan MCP tools will now be available in your Cursor environment

📝 VSCode Integration

For VSCode users, add the following to your settings.json file:

1. Open VS Code settings (⌘+Shift+P, then type "Preferences: Open Settings (JSON)")
2. Add the following configuration:
   "mcp": {
   "inputs": [],
   "servers": {
   "shodan": {
   "command": "/path/to/uv",
   "args": [
   "--directory",
   "/path/to/shodan-mcp/shodan-mcp-server",
   "run",
   "shodan_mcp.py"
   ],
   "env": {}
   }
   }
   }
3. Replace /path/to/uv with your actual path to the uv executable (e.g., ~/.local/bin/uv on macOS/Linux or the full path on Windows)
4. Replace /path/to/shodan-mcp with the actual path to your shodan-mcp project directory
5. Save the settings and restart VS Code
6. Access through the built-in AI features or command palette

Installation with UV

**uv is recommended for managing Python environments and dependencies due to its speed and reliability:

Install uv if you don't have it

curl -sSf https://github.com/astral-sh/uv/releases/download/0.1.21/uv-installer.sh | sh

Install project dependencies with uv

uv pip install -r requirements.txt

Run the MCP server with uv

uv --directory /path/to/shodan-mcp/shodan-mcp-server run shodan_mcp.py

🚀 Available Commands

📊 Example Usage

Integration with AI Assistants

SHODAN-MCP is designed to be used through AI assistants and IDEs that support the MCP protocol. You can interact with Shodan using natural language:

"Find all exposed Jenkins servers in Germany"
"Check if 8.8.8.8 has any known vulnerabilities"
"Show me the distribution of Nginx servers by country"
"List the top 5 countries with vulnerable MongoDB instances"
"Get DNS information for example.com"

Available Commands through MCP

Once configured in your IDE or AI assistant, SHODAN-MCP offers the following commands:

💻 System Compatibility

Note: This project has been primarily developed and tested on macOS and Linux environments. Contributions to expand and test compatibility on other platforms are welcome!

🔧 Technical Architecture

SHODAN-MCP is built using:

• FastMCP: High-performance async framework for API interactions
• Shodan API Client: Official Python client for Shodan
• HTTPX: Modern asynchronous HTTP client
• Python-dotenv: For secure environment variable management
• MCP Protocol: For seamless integration with AI assistants

The system uses an asynchronous architecture to provide high-performance, non-blocking API interactions, enabling efficient processing of multiple requests simultaneously.

🔑 API Key Management

SHODAN-MCP uses the Shodan API key stored in a .env file in the project root. This approach keeps your API key secure and separate from the code.

1. Get an API key: Sign up at Shodan to obtain your API key
2. Create .env file: Create a .env file in the project root with the following content:

SHODAN_API_KEY=your_api_key_here  

The .env file is included in .gitignore to prevent your API key from being uploaded to public repositories. The project automatically loads the API key from this file using the python-dotenv library.

Security note: Never share your Shodan API key or include it in files that might be uploaded to public repositories.

🛡️ Security & Ethics

This tool is designed for legitimate security research and defensive purposes. Users are responsible for ensuring they comply with:

• Applicable laws and regulations
• Shodan's terms of service
• Ethical standards for security research

Always obtain proper authorization before scanning or analyzing systems you don't own.

📚 Usage Notes

• Some commands consume Shodan API credits (see Shodan pricing)
• Results provide comprehensive intelligence for analysis
• Data is presented in a structured, readable format
• Advanced formatting instructions ensure clarity of technical details
• For bulk operations, consider using the async batch methods to optimize performance

🔮 Upcoming Features

The following features are planned for future releases:

• Markdown Report Generation: Automatically create comprehensive reports in Markdown format for all queries
• Batch Processing: Process multiple queries in parallel for improved efficiency
• Advanced Visualization: Visual representations of search results and networks
• Docker Container: Ready-to-use containerized version for easier deployment
• Cross-Platform Testing: Expanded testing and support for Windows and other platforms

👥 Contributions Welcome!

This project was created by a security enthusiast, not a professional developer. There are many areas that could benefit from improvement, and contributions of all kinds are welcome!

Areas Needing Improvement

• Code Quality: Refactoring and optimization
• Error Handling: More robust error handling and recovery
• Documentation: Expanded examples and use cases
• Testing: Unit tests and integration tests
• UI Development: A simple web interface for non-programmers
• Cross-Platform Support: Testing and fixes for Windows and other platforms

If you'd like to contribute, please feel free to submit pull requests or open issues with suggestions. No contribution is too small, and all help is greatly appreciated!

🐛 Troubleshooting

🌟 Credits

• Powered by me 😇 using Shodan API - The Internet's Search Engine
• Developed using Python's async architecture for optimal performance
• MCP protocol specification by Anthropic

SHODAN-MCP: See everything. Know everything.

0xh3l1x creation