ZoomEye MCP服务器

这是一个基于查询条件提供网络资产信息的模型上下文协议(MCP)服务器。该服务器允许大型语言模型(LLM)通过使用dork搜索语法等参数向ZoomEye发起查询，从而获取网络资产信息。

该MCP服务器已集成到Claude Desktop、Cursor、Windsurf、Cline、Continue和Zed等AI助手和开发环境中，使它们能够通过自然语言交互搜索和分析联网设备、服务和漏洞。

功能特性

使用dork语法查询ZoomEye网络资产信息
缓存机制提升性能并减少API调用
API请求失败时的自动重试机制
全面的错误处理和日志记录

可用工具

zoomeye_search - 根据查询条件获取网络资产信息
- 必需参数：
  - qbase64 (字符串)：ZoomEye搜索的Base64编码查询字符串
- 可选参数：
  - page (整数)：查看资产页码，默认为1
  - pagesize (整数)：每页记录数，默认为10，最大为1000
  - fields (字符串)：要返回的字段，用逗号分隔
  - sub_type (字符串)：数据类型，支持v4、v6和web，默认为v4
  - facets (字符串)：统计项，如果有多个则用逗号分隔
  - ignore_cache (布尔值)：是否忽略缓存

使用指南

基本使用

服务器运行后，您可以通过AI助手或开发环境与之交互。使用方法如下：

使用上述安装方法之一启动服务器
配置您的AI助手(Claude Desktop、Cursor、Windsurf、Cline、Continue、Zed等)使用该服务器
使用自然语言查询网络信息

searchexample

搜索语法指南

搜索范围涵盖设备(IPv4、IPv6)和网站(域名)
输入搜索字符串时，系统将以"全局"模式匹配关键词，包括HTTP、SSH、FTP等各种协议的内容(如HTTP/HTTPS协议头、正文、SSL、标题和其他协议横幅)
搜索字符串不区分大小写，并会进行分词匹配(搜索结果页面提供"分词"测试功能)。使用==进行搜索时，会强制执行严格的大小写敏感匹配语法
搜索字符串请使用引号括起来(如"Cisco System"或'Cisco System')。如果搜索字符串包含引号，请使用转义字符，例如"a"b"。如果搜索字符串包含括号，请使用转义字符，例如portinfo()

您可以在prompts.py中查看更详细的搜索语法规则。

有关ZoomEye搜索API的更多信息，请参阅ZoomEye API v2文档。

入门指南

前提条件

ZoomEye API密钥
- 在ZoomEye注册账户
- 从账户设置中获取您的API密钥
- 该API密钥将用于向ZoomEye API进行身份验证
Python环境
- 需要Python 3.10或更高版本
- 或者您可以使用Docker运行服务器而无需安装Python

安装方式

使用PIP安装

您也可以通过pip安装mcp-server-zoomeye：

pip install mcp-server-zoomeye

安装后，您可以使用以下命令作为脚本运行：

python -m mcp_server_zoomeye

使用Docker运行

您还可以使用Docker运行ZoomEye MCP服务器：

从Docker Hub拉取镜像

# 拉取最新镜像
docker pull zoomeyeteam/mcp-server-zoomeye:latest

# 使用您的API密钥运行容器
docker run -i --rm -e ZOOMEYE_API_KEY=your_api_key_here zoomeyeteam/mcp-server-zoomeye:latest

注意：我们提供支持linux/amd64和linux/arm64平台的多架构Docker镜像，可在Intel/AMD和ARM(如Apple Silicon)处理器上运行。

从源代码构建

或者，您可以从源代码构建Docker镜像：

# 克隆仓库
git clone https://github.com/zoomeye-ai/mcp_zoomeye.git
cd mcp_zoomeye

# 构建Docker镜像
docker build -t zoomeyeteam/mcp-server-zoomeye:local .

# 运行容器
docker run -i --rm -e ZOOMEYE_API_KEY=your_api_key_here zoomeyeteam/mcp-server-zoomeye:local

使用uv工具

uv是一个用Rust编写的快速Python包安装程序和解析器，是pip的现代替代品，提供显著的性能提升。

安装uv

# 使用curl安装uv (macOS/Linux)
curl -LsSf https://astral.sh/uv/install.sh | sh

# 或者使用PowerShell安装 (Windows)
irm https://astral.sh/uv/install.ps1 | iex

# 或者使用Homebrew安装 (macOS)
brew install uv

使用uvx运行mcp-server-zoomeye

使用uvx时不需要特定安装，它允许您直接运行Python包：

使用uv安装

或者，您可以使用uv安装该包：

# 在当前环境中安装
uv pip install mcp-server-zoomeye

# 或者创建并安装到新的虚拟环境
uv venv
uv pip install mcp-server-zoomeye

配置

环境变量

ZoomEye MCP服务器需要以下环境变量：

ZOOMEYE_API_KEY：用于身份验证的ZoomEye API密钥

您可以通过以下几种方式设置此环境变量：

在shell会话中导出：

export ZOOMEYE_API_KEY="your_api_key_here"

运行容器时直接传递(对于Docker)：

docker run -i --rm -e ZOOMEYE_API_KEY=your_api_key_here zoomeyeteam/mcp-server-zoomeye:latest

配置Claude.app

在Claude设置中添加以下内容：

使用uvx

"mcpServers": {
  "zoomeye": {
    "command": "uvx",
    "args": ["mcp-server-zoomeye"],
    "env": {
        "ZOOMEYE_API_KEY": "your_api_key_here"
    }
  }
}

使用docker

"mcpServers": {
  "zoomeye": {
    "command": "docker",
    "args": ["run", "-i", "--rm", "-e", "ZOOMEYE_API_KEY=your_api_key_here", "zoomeyeteam/mcp-server-zoomeye:latest"],
    "env": {
      "ZOOMEYE_API_KEY": "your_api_key_here"
    }
  }
}

通过pip安装

"mcpServers": {
  "zoomeye": {
    "command": "python",
    "args": ["-m", "mcp_server_zoomeye"],
    "env": {
        "ZOOMEYE_API_KEY": "your_api_key_here"
    }
  }
}

配置Zed

在Zed的settings.json中添加以下内容：

使用uvx

"context_servers": [
  "mcp-server-zoomeye": {
    "command": "uvx",
    "args": ["mcp-server-zoomeye"],
    "env": {
        "ZOOMEYE_API_KEY": "your_api_key_here"
    }
  }
],

通过pip安装

"context_servers": {
  "mcp-server-zoomeye": {
    "command": "python",
    "args": ["-m", "mcp_server_zoomeye"],
    "env": {
        "ZOOMEYE_API_KEY": "your_api_key_here"
    }
  }
},

示例交互

示例1：检索全球Apache Tomcat资产

{
  "name": "zoomeye_search",
  "arguments": {
    "qbase64": "app=\"Apache Tomcat\""
  }
}

响应：

{
  "code": 60000,
  "message": "success",
  "total": 163139107,
  "query": "title=\"cisco vpn\"",
  "data": [
    {
      "url": "https://1.1.1.1:443",
      "ssl.jarm": "29d29d15d29d29d00029d29d29d29dea0f89a2e5fb09e4d8e099befed92cfa",
      "ssl.ja3s": "45094d08156d110d8ee97b204143db14",
      "iconhash_md5": "f3418a443e7d841097c714d69ec4bcb8",
      "robots_md5": "0b5ce08db7fb8fffe4e14d05588d49d9",
      "security_md5": "0b5ce08db7fb8fffe4e14d05588d49d9",
      "ip": "1.1.1.1",
      "domain": "www.google.com",
      "hostname": "SPACEX",
      "os": "windows",
      "port": 443,
      "service": "https",
      "title": ["GoogleGoogle appsGoogle Search"],
      "version": "1.1.0",
      "device": "webcam",
      "rdns": "c01031-001.cust.wallcloud.ch",
      "product": "OpenSSD",
      "header": "HTTP/1.1 302 Found Location: https://www.google.com/?gws_rd=ssl Cache-Control: private...",
      "header_hash": "27f9973fe57298c3b63919259877a84d",
      "body": "HTTP/1.1 302 Found Location: https://www.google.com/?gws_rd=ssl Cache-Control: private...",
      "body_hash": "84a18166fde3ee7e7c974b8d1e7e21b4",
      "banner": "SSH-2.0-OpenSSH_7.6p1 Ubuntu-4ubuntu0.3",
      "update_time": "2024-07-03T14:34:10",
      "header.server.name": "nginx",
      "header.server.version": "1.8.1",
      "continent.name": "Europe",
      "country.name": "Germany",
      "province.name": "Hesse",
      "city.name": "Frankfurt",
      "lon": "118.753262",
      "lat": "32.064838",
      "isp.name": "aviel.ru",
      "organization.name": "SERVISFIRST BANK",
      "zipcode": "210003",
      "idc": 0,
      "honeypot": 0,
      "asn": 4837,
      "protocol": "tcp",
      "ssl": "SSL Certificate Version: TLS 1.2 CipherSuit: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256...",
      "primary_industry": "Finance",
      "sub_industry": "bank",
      "rank": 60
    }
  ]
}

调试与故障排除

使用MCP检查器

模型上下文协议检查器是一个通过模拟客户端交互来调试MCP服务器的工具。您可以使用它来测试您的ZoomEye MCP服务器：

# 对于uvx安装
npx @modelcontextprotocol/inspector uvx mcp-server-zoomeye

# 如果本地开发
cd path/to/servers/src/mcp_server_zoomeye
npx @modelcontextprotocol/inspector uv run mcp-server-zoomeye

常见问题

身份验证错误
- 确保您的ZoomEye API密钥正确，并已正确设置为环境变量
- 检查您的API密钥是否已过期或被撤销
连接问题
- 验证您的网络连接
- 检查ZoomEye API是否宕机
无结果
- 您的查询可能过于具体或包含语法错误
- 尝试简化查询或使用不同的搜索词
速率限制
- ZoomEye API根据您的账户类型有速率限制
- 分散您的请求或升级账户以获得更高的限制

高级用法

缓存

ZoomEye MCP服务器实现了缓存以提高性能并减少API调用：

响应根据查询参数进行缓存
缓存持续时间可配置(默认：1小时)
您可以通过在查询中设置ignore_cache为true来绕过缓存

自定义字段

您可以在查询结果中请求特定字段，使用fields参数：

{
  "name": "zoomeye_search",
  "arguments": {
    "qbase64": "app=\"Apache\"",
    "fields": "ip,port,domain,service,os,country,city"
  }
}

分页

对于返回大量结果的查询，您可以分页浏览：

{
  "name": "zoomeye_search",
  "arguments": {
    "qbase64": "app=\"Apache\"",
    "page": 2,
    "pagesize": 20
  }
}

贡献指南

我们鼓励为mcp-server-zoomeye做出贡献，以帮助扩展和改进其功能。无论是添加新的相关工具、增强现有功能还是改进文档，您的贡献都很有价值。

有关其他MCP服务器和实现模式的示例，请参阅：
https://github.com/modelcontextprotocol/servers

欢迎提交拉取请求！请随时贡献新想法、错误修复或增强功能，使mcp-server-zoomeye更加强大和实用。

许可证

mcp-server-zoomeye采用MIT许可证。这意味着您可以自由使用、修改和分发该软件，但须遵守MIT许可证的条款和条件。有关更多信息，请参阅项目仓库中的LICENSE文件。