shodan-mcp-server

这是一个模型上下文协议 (MCP) 服务器，提供对 Shodan API 的访问。 它允许您以编程方式查询 Shodan，以获取有关设备、漏洞等的信息。

目录

• 简介
• 安装
• 配置
• Node.js 中的用法
• API 文档
  • get_ip_info
  • dns_lookup
  • get_vulnerabilities
  • cve_info
  • search
• 项目结构
• 贡献
• 许可证

简介

shodan-mcp-server 提供了一种使用模型上下文协议 (MCP) 将 Shodan 情报集成到您的应用程序中的简单方法。 它公开了几个工具，允许您查询 Shodan 以获取各种类型的信息。

特性

主机信息：获取有关 IP 地址的详细信息 搜索：使用 Shodan 的搜索语法查询 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 地址
}

输出：

一个包含与 IP 地址关联的漏洞列表的 JSON 对象。

cve_info

检索有关特定 CVE ID 的信息。

输入：

{
  "cve": "string" // 要查询的 CVE ID
}

输出：

一个包含有关 CVE ID 信息的 JSON 对象。

search

搜索 Shodan 中与查询匹配的设备。

输入：

{
  "query": "string" // 搜索查询
}

输出：

一个包含与查询匹配的设备列表的 JSON 对象。

项目结构

shodan-mcp-server/
├── .gitignore
├── package.json
├── README.md
├── tsconfig.json
└── src/
    ├── index.ts
    └── index.mts

许可证

MIT