Zoomeye MCP Server

🚀 ZoomEye MCP Server

A Model Context Protocol (MCP) server that provides access to the ZoomEye v2 API, enabling AI assistants to query host and network data across the internet, view account quotas, and (for paid plans) retrieve IP history.

🚀 Quick Start

This MCP server offers seamless access to ZoomEye v2 API, empowering AI assistants to query internet - wide host and network data, check account quotas, and (for paid plans) obtain IP history.

✨ Features

• Host Search: Query devices by IP, port, service, etc.
• Network Search: Index network - facing applications and components.
• Account Information: View your ZoomEye plan and remaining query quotas.
• Result Sampling: Limit response size and select required fields.
• Summary Generation: Automatically generate summaries of top countries, ports, and organizations.
• (Paid) IP History: Retrieve historical scan data for specific IPs.

📦 Installation

Prerequisites

• Node.js ≥ 16
• ZoomEye API key (obtain at https://www.zoomeye.org/profile)
• Internet access to https://api.zoomeye.org

Steps

1. Clone the repository:

   git clone https://github.com/help116114/zoomeye-mcp-server.git
   cd zoomeye-mcp-server
   

2. Install dependencies:

   npm install
   

3. Build the server:

   npm run build
   

4. Set your ZoomEye API key:

   export Zoomeye_API_KEY="your-api-key-here"
   

5. Start the server:

   npm start
   

📚 Documentation

MCP Integration

This server can be integrated with MCP - supported AI LLMs. To add it to Cline, Curser, or Claude:

1. Add the server to your MCP settings:

   {
     "mcpServers": {
       "zoomeye": {
         "command": "node",
         "args": ["./build/index.js"],
         "env": {
           "ZOOMEYE_API_KEY": "your-api-key-here"
         }
       }
     }
   }
   

2. Reload the new MCP server.

Available Tools

get_account_info

Get detailed information about a specific IP address. Parameters:

• IP address: The IP address to query (required).

Example response:

{
  "status": "success",
  "data": {
    "ip": "192.168.1.1",
    "hostname": "example.com",
    "geolocation": {
      "country": "China",
      "city": "Beijing"
    },
    "ports": ["80", "443"]
  }
}

search_host

Search for host information by IP or domain name. Parameters:

• query: The IP address or domain name to search (required).
• max_items: The maximum number of items to return (optional, default is 10).

get_ip_history

Retrieve historical scan data for a specific IP. Parameters:

• ip: The specific IP address (required).

Resources

zoomeye://host/{ip}: Represents the host resource to query.

API Limits

• Free Plan: Limited to 100 requests per hour.
• Paid Plan: Offers higher quotas and more advanced features.

📄 License

ZGCLAB

Developer

NASP