Shodan MCP Server

🚀 shodan-mcp-server

shodan-mcp-serverは、Shodan APIへのアクセスを提供するModel Context Protocol (MCP)サーバーです。これを使用すると、プログラムからShodanをクエリして、デバイスや脆弱性などの情報を取得できます。

🚀 クイックスタート

shodan-mcp-serverを使用することで、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の実際のパスに置き換えてください。

Node.jsでの使用

@modelcontextprotocol/sdkパッケージを使用して、MCPサーバーをNode.jsと組み合わせて使用できます。

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ファイルを参照してください。