| Name | mcp-server-zoomeye JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A Model Context Protocol server providing tools for ZoomEye queries for LLMs |
| upload_time | 2025-03-18 11:38:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
llm
mcp
zoomeye
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ZoomEye MCP Server
A Model Context Protocol server that provides network asset information based on query conditions. This server allows LLMs to obtain network asset information and supports querying network asset information by zoomeye dork etc.
## Features
- Query ZoomEye for network asset information using dorks
- Caching mechanism to improve performance and reduce API calls
- Automatic retry mechanism for failed API requests
- Comprehensive error handling and logging
## Available Tools
- `zoomeye_search` - Get network asset information based on query conditions.
- Required parameters:
- `qbase64` (string): Base64 encoded query string for ZoomEye search
- Optional parameters:
- `page` (integer): View asset page number, default is 1
- `pagesize` (integer): Number of records per page, default is 10, maximum is 1000
- `fields` (string): The fields to return, separated by commas
- `sub_type` (string): Data type, supports v4, v6, and web. Default is v4
- `facets` (string): Statistical items, separated by commas if there are multiple
- `ignore_cache` (boolean): Whether to ignore the cache
## Installation
### Using uv (Recommended)
No specific installation is required when using [`uv`](https://docs.astral.sh/uv/). We will use [`uvx`](https://docs.astral.sh/uv/guides/tools/) to directly run *mcp-server-zoomeye*.
### Using PIP
Alternatively, you can install `mcp-server-zoomeye` via pip:
```bash
pip install mcp-server-zoomeye
```
After installation, you can run it as a script using the following command:
```bash
python -m mcp_server_zoomeye
```
## Configuration
### Configure Claude.app
Add the following in Claude settings:
<details>
<summary>Using uvx</summary>
```json
"mcpServers": {
"zoomeye": {
"command": "uvx",
"args": ["mcp-server-zoomeye"],
"env": {
"ZOOMEYE_API_KEY": "your_api_key_here"
}
}
}
```
</details>
<details>
<summary>Using docker</summary>
```json
"mcpServers": {
"zoomeye": {
"command": "docker",
"args": ["run", "-i", "--rm", "-e", "ZOOMEYE_API_KEY=your_api_key_here", "mcp/zoomeye"],
"env": {
"ZOOMEYE_API_KEY": "your_api_key_here"
}
}
}
```
</details>
<details>
<summary>Installed via pip</summary>
```json
"mcpServers": {
"zoomeye": {
"command": "python",
"args": ["-m", "mcp_server_zoomeye"],
"env": {
"ZOOMEYE_API_KEY": "your_api_key_here"
}
}
}
```
</details>
### Configure Zed
Add the following in Zed's settings.json:
<details>
<summary>Using uvx</summary>
```json
"context_servers": [
"mcp-server-zoomeye": {
"command": "uvx",
"args": ["mcp-server-zoomeye"],
"env": {
"ZOOMEYE_API_KEY": "your_api_key_here"
}
}
],
```
</details>
<details>
<summary>Installed via pip</summary>
```json
"context_servers": {
"mcp-server-zoomeye": {
"command": "python",
"args": ["-m", "mcp_server_zoomeye"],
"env": {
"ZOOMEYE_API_KEY": "your_api_key_here"
}
}
},
```
</details>
## API Documentation
### ZoomEye Search API
The ZoomEye Search API allows you to search for network assets using ZoomEye dorks. The API endpoint is `https://api.zoomeye.ai/v2/search`.
## Example Interaction
1. Retrieve global Apache Tomcat assets:
```json
{
"name": "zoomeye_search",
"arguments": {
"qbase64": "app=\"Apache Tomcat\""
}
}
```
Response:
```json
{
"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
}
]
}
```
## Debugging
You can use the MCP inspector to debug the server. For uvx installation:
```bash
npx @modelcontextprotocol/inspector uvx mcp-server-zoomeye
```
Or if you have installed the package in a specific directory or are developing:
```bash
cd path/to/servers/src/mcp_server_zoomeye
npx @modelcontextprotocol/inspector uv run mcp-server-zoomeye
```
## Building
Docker Build:
```bash
docker build -t mcp/zoomeye .
```
## Contributing
We encourage contributions to mcp-server-zoomeye to help expand and improve its functionality. Whether it's adding new related tools, enhancing existing features, or improving documentation, your input is valuable.
For examples of other MCP servers and implementation patterns, see:
https://github.com/modelcontextprotocol/servers
Pull requests are welcome! Feel free to contribute new ideas, bug fixes, or enhancements to make mcp-server-zoomeye more robust and practical.
## License
mcp-server-zoomeye is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more information, see the LICENSE file in the project repository.
```
Raw data
{
"_id": null,
"home_page": null,
"name": "mcp-server-zoomeye",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "llm, mcp, zoomeye",
"author": null,
"author_email": "zoomeye team <support@zoomeye.ai>",
"download_url": "https://files.pythonhosted.org/packages/32/c0/e07735cab3ed62f8f4a9da9b4d3f8ddcdd4ae061739c108c961c652d958b/mcp_server_zoomeye-0.1.1.tar.gz",
"platform": null,
"description": "# ZoomEye MCP Server\n\nA Model Context Protocol server that provides network asset information based on query conditions. This server allows LLMs to obtain network asset information and supports querying network asset information by zoomeye dork etc.\n\n## Features\n\n- Query ZoomEye for network asset information using dorks\n- Caching mechanism to improve performance and reduce API calls\n- Automatic retry mechanism for failed API requests\n- Comprehensive error handling and logging\n\n## Available Tools\n\n- `zoomeye_search` - Get network asset information based on query conditions.\n - Required parameters:\n - `qbase64` (string): Base64 encoded query string for ZoomEye search\n - Optional parameters:\n - `page` (integer): View asset page number, default is 1\n - `pagesize` (integer): Number of records per page, default is 10, maximum is 1000\n - `fields` (string): The fields to return, separated by commas\n - `sub_type` (string): Data type, supports v4, v6, and web. Default is v4\n - `facets` (string): Statistical items, separated by commas if there are multiple\n - `ignore_cache` (boolean): Whether to ignore the cache\n\n## Installation\n\n### Using uv (Recommended)\n\nNo specific installation is required when using [`uv`](https://docs.astral.sh/uv/). We will use [`uvx`](https://docs.astral.sh/uv/guides/tools/) to directly run *mcp-server-zoomeye*.\n\n### Using PIP\n\nAlternatively, you can install `mcp-server-zoomeye` via pip:\n\n```bash\npip install mcp-server-zoomeye\n```\n\nAfter installation, you can run it as a script using the following command:\n\n```bash\npython -m mcp_server_zoomeye\n```\n\n## Configuration\n\n### Configure Claude.app\n\nAdd the following in Claude settings:\n\n<details>\n<summary>Using uvx</summary>\n\n```json\n\"mcpServers\": {\n \"zoomeye\": {\n \"command\": \"uvx\",\n \"args\": [\"mcp-server-zoomeye\"],\n \"env\": {\n \"ZOOMEYE_API_KEY\": \"your_api_key_here\"\n }\n }\n}\n```\n</details>\n\n<details>\n<summary>Using docker</summary>\n\n```json\n\"mcpServers\": {\n \"zoomeye\": {\n \"command\": \"docker\",\n \"args\": [\"run\", \"-i\", \"--rm\", \"-e\", \"ZOOMEYE_API_KEY=your_api_key_here\", \"mcp/zoomeye\"],\n \"env\": {\n \"ZOOMEYE_API_KEY\": \"your_api_key_here\"\n }\n }\n}\n```\n</details>\n\n<details>\n<summary>Installed via pip</summary>\n\n```json\n\"mcpServers\": {\n \"zoomeye\": {\n \"command\": \"python\",\n \"args\": [\"-m\", \"mcp_server_zoomeye\"],\n \"env\": {\n \"ZOOMEYE_API_KEY\": \"your_api_key_here\"\n }\n }\n}\n```\n</details>\n\n### Configure Zed\n\nAdd the following in Zed's settings.json:\n\n<details>\n<summary>Using uvx</summary>\n\n```json\n\"context_servers\": [\n \"mcp-server-zoomeye\": {\n \"command\": \"uvx\",\n \"args\": [\"mcp-server-zoomeye\"],\n \"env\": {\n \"ZOOMEYE_API_KEY\": \"your_api_key_here\"\n }\n }\n],\n```\n</details>\n\n<details>\n<summary>Installed via pip</summary>\n\n```json\n\"context_servers\": {\n \"mcp-server-zoomeye\": {\n \"command\": \"python\",\n \"args\": [\"-m\", \"mcp_server_zoomeye\"],\n \"env\": {\n \"ZOOMEYE_API_KEY\": \"your_api_key_here\"\n }\n }\n},\n```\n</details>\n\n## API Documentation\n\n### ZoomEye Search API\n\nThe ZoomEye Search API allows you to search for network assets using ZoomEye dorks. The API endpoint is `https://api.zoomeye.ai/v2/search`.\n\n\n## Example Interaction\n\n1. Retrieve global Apache Tomcat assets:\n```json\n{\n \"name\": \"zoomeye_search\",\n \"arguments\": {\n \"qbase64\": \"app=\\\"Apache Tomcat\\\"\"\n }\n}\n```\nResponse:\n```json\n{\n \"code\": 60000,\n \"message\": \"success\",\n \"total\": 163139107,\n \"query\": \"title=\\\"cisco vpn\\\"\",\n \"data\": [\n {\n \"url\": \"https://1.1.1.1:443\",\n \"ssl.jarm\": \"29d29d15d29d29d00029d29d29d29dea0f89a2e5fb09e4d8e099befed92cfa\",\n \"ssl.ja3s\": \"45094d08156d110d8ee97b204143db14\",\n \"iconhash_md5\": \"f3418a443e7d841097c714d69ec4bcb8\",\n \"robots_md5\": \"0b5ce08db7fb8fffe4e14d05588d49d9\",\n \"security_md5\": \"0b5ce08db7fb8fffe4e14d05588d49d9\",\n \"ip\": \"1.1.1.1\",\n \"domain\": \"www.google.com\",\n \"hostname\": \"SPACEX\",\n \"os\": \"windows\",\n \"port\": 443,\n \"service\": \"https\",\n \"title\": [\"GoogleGoogle appsGoogle Search\"],\n \"version\": \"1.1.0\",\n \"device\": \"webcam\",\n \"rdns\": \"c01031-001.cust.wallcloud.ch\",\n \"product\": \"OpenSSD\",\n \"header\": \"HTTP/1.1 302 Found Location: https://www.google.com/?gws_rd=ssl Cache-Control: private...\",\n \"header_hash\": \"27f9973fe57298c3b63919259877a84d\",\n \"body\": \"HTTP/1.1 302 Found Location: https://www.google.com/?gws_rd=ssl Cache-Control: private...\",\n \"body_hash\": \"84a18166fde3ee7e7c974b8d1e7e21b4\",\n \"banner\": \"SSH-2.0-OpenSSH_7.6p1 Ubuntu-4ubuntu0.3\",\n \"update_time\": \"2024-07-03T14:34:10\",\n \"header.server.name\": \"nginx\",\n \"header.server.version\": \"1.8.1\",\n \"continent.name\": \"Europe\",\n \"country.name\": \"Germany\",\n \"province.name\": \"Hesse\",\n \"city.name\": \"Frankfurt\",\n \"lon\": \"118.753262\",\n \"lat\": \"32.064838\",\n \"isp.name\": \"aviel.ru\",\n \"organization.name\": \"SERVISFIRST BANK\",\n \"zipcode\": \"210003\",\n \"idc\": 0,\n \"honeypot\": 0,\n \"asn\": 4837,\n \"protocol\": \"tcp\",\n \"ssl\": \"SSL Certificate Version: TLS 1.2 CipherSuit: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256...\",\n \"primary_industry\": \"Finance\",\n \"sub_industry\": \"bank\",\n \"rank\": 60\n }\n ]\n}\n```\n\n## Debugging\n\nYou can use the MCP inspector to debug the server. For uvx installation:\n\n```bash\nnpx @modelcontextprotocol/inspector uvx mcp-server-zoomeye\n```\n\nOr if you have installed the package in a specific directory or are developing:\n\n```bash\ncd path/to/servers/src/mcp_server_zoomeye\nnpx @modelcontextprotocol/inspector uv run mcp-server-zoomeye\n```\n\n## Building\n\nDocker Build:\n\n```bash\ndocker build -t mcp/zoomeye .\n```\n\n## Contributing\n\nWe encourage contributions to mcp-server-zoomeye to help expand and improve its functionality. Whether it's adding new related tools, enhancing existing features, or improving documentation, your input is valuable.\n\nFor examples of other MCP servers and implementation patterns, see:\nhttps://github.com/modelcontextprotocol/servers\n\nPull requests are welcome! Feel free to contribute new ideas, bug fixes, or enhancements to make mcp-server-zoomeye more robust and practical.\n\n## License\n\nmcp-server-zoomeye is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more information, see the LICENSE file in the project repository.\n```",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Model Context Protocol server providing tools for ZoomEye queries for LLMs",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [
"llm",
" mcp",
" zoomeye"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3ccad32a4e9382bbbe0a5d70547a9d678cda682b36b925b5aaa610a4ff94d19c",
"md5": "991edd5a32c0c6abc39d4987d4f0ec9d",
"sha256": "91e04eff97e9b114b635a9baad28f4b5b6d0351e986dbc2ed5ff35ba1730e427"
},
"downloads": -1,
"filename": "mcp_server_zoomeye-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "991edd5a32c0c6abc39d4987d4f0ec9d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7165,
"upload_time": "2025-03-18T11:38:25",
"upload_time_iso_8601": "2025-03-18T11:38:25.393564Z",
"url": "https://files.pythonhosted.org/packages/3c/ca/d32a4e9382bbbe0a5d70547a9d678cda682b36b925b5aaa610a4ff94d19c/mcp_server_zoomeye-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "32c0e07735cab3ed62f8f4a9da9b4d3f8ddcdd4ae061739c108c961c652d958b",
"md5": "32899ddd1990351061e1a0c8384e9d61",
"sha256": "b65e90773bba998ca9470417f01fc8aba7440e5c7793e3c7ecbc8a54b0b5bb4b"
},
"downloads": -1,
"filename": "mcp_server_zoomeye-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "32899ddd1990351061e1a0c8384e9d61",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 29658,
"upload_time": "2025-03-18T11:38:27",
"upload_time_iso_8601": "2025-03-18T11:38:27.085613Z",
"url": "https://files.pythonhosted.org/packages/32/c0/e07735cab3ed62f8f4a9da9b4d3f8ddcdd4ae061739c108c961c652d958b/mcp_server_zoomeye-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-18 11:38:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mcp-server-zoomeye"
}
