🚀 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 安装服务器、配置环境变量以及启动服务器，具体步骤如下：
- 使用
npm install -g mcp-server-zoomeye进行全局安装。 - 配置
ZOOM_EYE_API_KEY环境变量，根据不同系统选择相应的设置命令。 - 使用
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