shodan-mcp-server

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

目录

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

简介

shodan-mcp-server 提供了一种简便的方式，将 Shodan 情报集成到您的应用程序中，使用模型上下文协议 (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 许可证。