shodan-mcp-server

这是一个提供对Shodan API访问的Model Context Protocol (MCP)服务器。它允许您通过编程方式查询Shodan以获取设备、漏洞等信息。

目录

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

简介

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的实际路径。

Node.js中的使用

您可以使用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文件。