MCP Zoomeye

🚀 ZoomEye MCP 服務器指南

本指南詳細介紹了 ZoomEye MCP 服務器的安裝、配置、使用方法，以及調試、高級功能等內容，幫助你快速上手並高效使用該服務器。

🚀 快速開始

安裝 ZoomEye MCP 服務器

使用 npm 進行全局安裝：

npm install -g mcp-server-zoomeye

安裝完成後，可通過以下命令查看幫助信息並啟動：

mcp-server-zoomeye --help

配置環境變量

為確保 ZoomEye API 能正常訪問，需設置 ZOOM_EYE_API_KEY 環境變量。

• Unix/MacOS 系統：

export ZOOM_EYE_API_KEY='your_api_key_here'

• Windows 系統：

set ZOOM_EYE_API_KEY=your_api_key_here

啟動 MCP 服務器

啟動服務器並綁定到指定端口（默認端口為 3000）：

mcp-server-zoomeye --port 3000

📦 安裝指南

安裝過程主要包括使用 npm 安裝服務器、配置環境變量以及啟動服務器，具體步驟如下：

1. 使用 npm install -g mcp-server-zoomeye 進行全局安裝。
2. 配置 ZOOM_EYE_API_KEY 環境變量，根據不同系統選擇相應的設置命令。
3. 使用 mcp-server-zoomeye --port 3000 啟動服務器。

💻 使用示例

基礎用法

發送 POST 請求至 http://localhost:3000/mcp，請求體示例如下：

{
  "name": "zoomeye_search",
  "arguments": {
    "qbase64": "app=\"Apache\"",
    "page": 1,
    "pagesize": 50
  }
}

示例響應

請求成功後，會返回如下格式的響應：

{
  "id": "unique requestId",
  "status": "success",
  "result": {
    "data": [
      // 返回的結果數據數組
    ],
    "total": 100,
    "page": 1,
    "pagesize": 50
  }
}

🔧 技術細節

調試與故障排除

使用 MCP 檢查器

• 檢查 ZoomEye MCP 服務器：

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 密鑰正確且已設置為環境變量。
  • 檢查密鑰是否過期或被 revoke。
• 連接問題：
  • 驗證網絡連接。
  • 確認 ZoomEye API 是否正常運行。
• 無結果：
  • 查詢可能過於具體或存在語法錯誤。
  • 嘗試簡化查詢或使用不同的搜索詞。
• 速率限制：
  • ZoomEye API 根據賬戶類型有不同的速率限制。
  • 調整請求頻率或升級賬戶以獲得更高限制。

高級功能

緩存機制

ZoomEye MCP 服務器提供了基於查詢參數的響應緩存功能，緩存時長可配置（默認為 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": 50
  }
}

🤝 貢獻與許可

提交代碼

如果你想為項目貢獻代碼，請通過 GitHub 提交 PR，步驟如下：

git clone git@github.com:yourusername/mcp-server-zoomeye.git
cd mcp-server-zoomeye
npm install

授權協議

本項目採用 Apache 2.0 許可證，詳細信息請查看 LICENSE 文件。

📞 聯繫方式

如果你有任何問題或建議，可通過以下方式聯繫我們：

• 郵件：support@zoomeye.com
• 微信：zoomeye_support