Shodan MCP Server

🚀 shodan - mcp - 服務器

shodan-mcp-server 是一個基於模型上下文協議（MCP）的服務器，它為用戶提供了便捷訪問 Shodan API 的途徑。藉助該服務器，您能夠以編程方式對 Shodan 進行查詢，獲取設備信息、漏洞詳情等各類相關數據，輕鬆將 Shodan 情報集成到自己的應用程序中。

🚀 快速開始

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

✨ 主要特性

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

📦 安裝指南

克隆倉庫

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

安裝依賴項

npm install

構建項目

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 替換為您的實際路徑。

與 Node.js 使用

const { Client } = require('mcp-client');

async function main() {
    const client = new Client({
        server: 'http://localhost:3000'
    });

    try {
        // 示例：查詢 Shodan
        const response = await client.query('example query');
        console.log(response);
    } catch (error) {
        console.error(error);
    }
}

main();

API 文檔

get_ip_info

• 描述：獲取特定 IP 地址的詳細信息。
• 參數：
  • ip（字符串）：要查詢的 IP 地址。
• 返回值：對象，包含 IP 的詳細信息。

dns_lookup

• 描述：解析域名。
• 參數：
  • domain（字符串）：要解析的域名。
• 返回值：數組，包含解析後的 IP 地址列表。

get_vulnerabilities

• 描述：獲取與特定 IP 相關的漏洞信息。
• 參數：
  • ip（字符串）：要查詢的 IP 地址。
• 返回值：數組，包含相關漏洞的信息。

cve_info

• 描述：獲取特定 CVE 漏洞的詳細信息。
• 參數：
  • cve_id（字符串）：要查詢的 CVE ID。
• 返回值：對象，包含 CVE 的詳細信息。

search

• 描述：使用 Shodan 查詢語法進行搜索。
• 參數：
  • query（字符串）：搜索查詢字符串。
• 返回值：數組，包含搜索結果的信息。

項目結構

shodan-mcp-server/
├── src/
│   ├── server.js          # 主服務器文件
│   └── routes/           # 路由定義
│       └── shodanRoutes.js   # Shodan 相關路由
├── package.json        # 項目依賴和腳本
└── README.md           # 項目文檔

貢獻

歡迎為這個項目貢獻代碼或提出問題。請參考 GitHub 倉庫 的貢獻指南。

📄 許可證

本項目使用 MIT 許可證。