Shodan MCP Server

🚀 shodan-mcp-server

shodan-mcp-server 是一個基於Model Context Protocol (MCP)的服務器，它提供了對Shodan API的訪問能力。藉助該服務器，您可以通過編程方式查詢Shodan，輕鬆獲取設備、漏洞等各類信息。

🚀 快速開始

shodan-mcp-server 提供了一種簡便的方式，將Shodan情報集成到您的應用程序中使用Model Context Protocol (MCP)。它公開了多種工具，允許您查詢Shodan以獲取各種類型的信息。

✨ 主要特性

• 主機信息：獲取特定IP地址的詳細信息
• 搜索：使用Shodan數據庫中的搜索語法進行查詢
• DNS解析：解析域名
• CVE信息：獲取特定CVE漏洞的詳細信息

📦 安裝指南

1. 克隆倉庫：

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

2. 安裝依賴項：

npm install

3. 構建項目：

npm run build

🛠️ 配置

1. 從Shodan獲取Shodan API密鑰。
2. 在您的MCP設置文件（例如~/.config/mcp/settings.json）中配置MCP服務器：

{
  "mcpServers": {
    "shodan": {
      "command": "node",
      "args": ["/path/to/shodan-mcp-server/build/index.js"],
      "env": {
        "SHODAN_API_KEY": "<your_shodan_api_key>"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

請將<your_shodan_api_key>替換為您實際的Shodan API密鑰，/path/to/shodan-mcp-server替換為shodan-mcp-server的實際路徑。

💻 使用示例

基礎用法

您可以使用MCP服務器與Node.js結合使用，利用@modelcontextprotocol/sdk包。

1. 安裝MCP SDK：

npm install @modelcontextprotocol/sdk

2. 使用use_mcp_tool函數調用工具：

import { use_mcp_tool } from '@modelcontextprotocol/sdk';

async function getIpInfo(ip) {
  const result = await use_mcp_tool('shodan', 'get_ip_info', { ip });
  console.log(result);
}

getIpInfo('8.8.8.8');

📚 詳細文檔

API文檔

get_ip_info

獲取特定IP地址的詳細信息。 輸入：

{
  "ip": "string" // 要查詢的IP地址
}

輸出： 一個包含IP地址信息的JSON對象。

dns_lookup

對給定域名執行DNS解析。 輸入：

{
  "hostname": "string" // 要解析的主機名
}

輸出： 一個包含解析後的IP地址的JSON對象。

get_vulnerabilities

跟蹤與特定IP地址相關的漏洞。 輸入：

{
  "ip": "string" // 要查詢漏洞的IP地址
}

輸出： 一個包含相關漏洞信息的JSON對象。

cve_info

獲取特定CVE漏洞的詳細信息。 輸入：

{
  "cve_id": "string" // 要查詢的CVE標識符
}

輸出： 一個包含CVE漏洞詳細信息的JSON對象。

search

根據過濾條件搜索Shodan數據庫。 輸入：

{
  "query": "string", // 搜索條件
  "page": number,     // 當前頁碼
  "limit": number     // 結果數量限制
}

輸出： 一個包含搜索結果的JSON數組，每個結果包括設備和服務信息。

🔧 技術細節

項目結構

project/
├── package.json          # 包含項目依賴和腳本的文件
├── index.js              # 主程序入口
└── build/                # 構建生成的目錄

🤝 貢獻

歡迎為這個項目做出貢獻！請參考如何貢獻文檔瞭解具體步驟。

📄 許可證

此項目受MIT許可證約束。有關詳細信息，請參閱LICENSE文件。