SuperAPI AI Directory
Partner with us中文AI newsFavorites
All toolsAI developer platformsmcp_zoomeye

mcp_zoomeye

Query network asset information from ZoomEye.

Open website

About this tool

Overview

mcp_zoomeye is a Model Context Protocol (MCP) server that provides network asset information based on query conditions. It allows Large Language Models (LLMs) to query ZoomEye using dorks and other search parameters to obtain network asset information. This server is the official open-source version of the ZoomEye MCP Server, designed to bring real-time cyberspace asset intelligence to AI assistants and development environments.

Key Capabilities

  • Obtains network asset information based on query conditions, supporting queries using ZoomEye dorks.
  • Provides a caching mechanism to improve performance and reduce API calls (default cache is 1 hour, can be bypassed via the ignore_cache parameter).
  • Provides an automatic retry mechanism for failed API requests.
  • Provides comprehensive error handling and logging.
  • The search scope covers devices (IPv4, IPv6) and websites (domains). The search string matches keywords in "global" mode, including content from various protocols such as HTTP, SSH, FTP (e.g., HTTP/HTTPS protocol headers, bodies, SSL, titles, and other protocol banners). The search string is case-insensitive and tokenized for matching; using == enforces case-sensitive exact matching and strict syntax.

Available Tools

zoomeye_search

Obtains network asset information based on query conditions.

Required parameters:

  • qbase64 (string): Base64-encoded ZoomEye search query string.

Optional parameters:

  • page (integer): The asset page number to view, defaults to 1.
  • pagesize (integer): Number of records per page, defaults to 10, maximum is 1000.
  • fields (string): Fields to return, comma-separated.
  • sub_type (string): Data type, supports v4, v6, and web, defaults to v4.
  • facets (string): Statistics items, multiple separated by commas.
  • ignore_cache (boolean): Whether to ignore the cache.

Usage

Obtain the ZoomEye API Key

  1. Visit https://www.zoomeye.ai
  2. Register or log in.
  3. Click the avatar → Profile.
  4. Copy the API-KEY.
  5. Set the environment variable:export ZOOMEYE_API_KEY="your_api_key_here"

Environment Requirements

  • Python 3.10 or higher, or use Docker to run the server without installing Python.

Installation and Running

mcp-server-zoomeye can be installed via pip, and run as a script after installation. The ZoomEye MCP server can also be run using Docker. The project provides multi-architecture Docker images, supporting linux/amd64 and linux/arm64 platforms, and can run on Intel/AMD and ARM (such as Apple Silicon) processors. Docker images can also be built from source.

Using uvx requires no specific installation and can run the Python package directly; the package can also be installed using uv.

Environment variables:

  • ZOOMEYE_API_KEY: The ZoomEye API key used for authentication.

Setting methods:

  • Export in a shell session:export ZOOMEYE_API_KEY="your_api_key_here"
  • Pass directly when running the container (Docker):docker run -i --rm -e ZOOMEYE_API_KEY=your_api_key_here zoomeyeteam/mcp-server-zoomeye:latest

Interacting with the AI Assistant

  1. Start the server using one of the installation methods above.
  2. Configure your AI assistant (Claude Desktop, Cursor, Windsurf, Cline, Continue, Zed, etc.) to use the server.
  3. Query network information using natural language.

Configuration Examples

Configuration can be added in Claude settings, or in Zed's settings.json (the specific configuration format is not yet expanded in the provided material).

Search Syntax Guide

  • Search scope covers devices (IPv4, IPv6) and websites (domains).
  • Search strings match keywords in "global" mode, including content from multiple protocols such as HTTP, SSH, FTP, and more.
  • Search strings are case-insensitive and tokenized matching is performed. Using == enforces case-sensitive exact matching and strict syntax.
  • Use quotes for search strings (such as "Cisco System" or 'Cisco System'). If the search string contains quotes, use escape characters, such as "a"b". If the search string contains parentheses, use escape characters, such as portinfo().
  • More detailed search syntax rules can be found in prompts.py.
  • For more information about the ZoomEye search API, please refer to the ZoomEye API v2 documentation.

Caching and Pagination

  • Responses are cached based on query parameters.
  • The cache duration is configurable (default 1 hour).
  • You can set ignore_cache to true in the query to bypass the cache.
  • You can use the fields parameter to request specific fields.
  • For queries that return a large number of results, you can browse through them in pages.

Debugging and Troubleshooting

  • You can use the Model Context Protocol Inspector to debug the MCP server, testing by simulating client interactions.
  • Authentication errors: Ensure the ZoomEye API key is correct and properly set as an environment variable; check whether the API key has expired or been revoked.
  • Connection issues: Verify your internet connection; check whether the ZoomEye API is experiencing downtime.
  • No results: The query may be too specific or contain syntax errors; try simplifying the query or using different search terms.
  • Rate limits: The ZoomEye API has rate limits based on account type; spread out requests or upgrade your account to increase the limit.

Use Cases

  • Query network asset information through natural language in an AI assistant or development environment.
  • Search global internet assets and track real-time changes.
  • Security researchers and developers obtain cyberspace asset intelligence.

Limitations

  • Requires a ZoomEye API key and may be subject to rate limits depending on account type.
  • The free trial is 7 days of free access to ZoomEye MCP (obtained by following Twitter @zoomeye_team and sending a direct message with "MCP" and a screenshot of the MCP settings).
  • The cache defaults to 1 hour and can be bypassed via parameters.

Open Source and License

mcp-server-zoomeye is released under the MIT License, allowing free use, modification, and distribution, subject to the terms and conditions of the MIT License. Contributions are welcome, including new tools, feature enhancements, and documentation improvements.type-based rate limits; spread out requests or upgrade your account to increase the limit.

Use Cases

  • Query network asset information through natural language in an AI assistant or development environment.
  • Search global internet assets and track real-time changes.
  • Security researchers and developers obtain cyberspace asset intelligence.

Limitations

  • Requires a ZoomEye API key and may be subject to rate limits depending on account type.
  • The free trial is 7 days of free access to ZoomEye MCP (obtained by following Twitter @zoomeye_team and sending a direct message with "MCP" and a screenshot of the MCP settings).
  • The cache defaults to 1 hour and can be bypassed via parameters.

Open Source and License

mcp-server-zoomeye is released under the MIT License, allowing free use, modification, and distribution, subject to the terms and conditions of the MIT License. Contributions are welcome, including new tools, feature enhancements, and documentation improvements.

Related tools

Browse category