Shodan MCP Server

🚀 shodan - mcp - server

このサーバーは、Shodan API へのアクセスを提供するモデルコンテキストプロトコル (MCP) サーバーです。プログラムを通じて Shodan をクエリし、デバイス情報、脆弱性、その他の関連情報を取得することができます。

🚀 クイックスタート

shodan - mcp - server を使用することで、モデルコンテキストプロトコル (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 を実際のパスに置き換えてください。

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 ライセンスの下で提供されています。