7gugu/zip-mcp

中文 | English
## Project Introduction
ZIP MCP Server is a compression server based on fastMCP and zip.js, implementing the Model Context Protocol (MCP). This project provides fully parameter-controlled ZIP compression, decompression, and query compression package information functions.
## Features
Supports compression and decompression of files and data
Supports multi-file packaging compression
Provides compression level control (0-9)
Supports password protection and encryption strength settings
Provides query function for compressed package metadata
Validates ZIP entry paths on decompression to prevent path traversal writes
## Security
Versions 1.0.6 and later fix an arbitrary file write issue in the decompress tool: malicious ZIP entry names (for example ../outside.txt) could previously be joined with the output directory and written outside the intended extraction root. Extraction now resolves the output root once, validates each entry path, and rejects absolute paths, drive-letter paths, .. segments, and any path that would escape the output directory.
Thanks to Ryan (vonbrubeck@gmail.com) for responsibly reporting this issue.
## Project Structure
bash
zip-mcp
├── src
│ ├── index.ts # Application entry point
│ ├── utils
│ │ ├── compression.ts # Compression and decompression implementation
│ │ └── safePath.ts # Safe ZIP entry path validation
├── tsconfig.json # TypeScript configuration file
├── package.json # npm configuration file
└── README.md # Project documentation
## Installation
You can install ZIP MCP Server globally using npm:
bash
npm install -g zip-mcp
## MCP Configuration
After installation, you can configure ZIP MCP in your MCP JSON configuration:
json
"mcpServers": {
"zip-mcp": {
"command": "zip-mcp",
"args": []
## Configure the MCP JSON in the AI Client
Claude Client: https://modelcontextprotocol.io/quickstart/user
Raycast: requires installing the MCP plugin
Cursor: https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers
## MCP Tool Description
ZIP MCP Server provides the following tools, which can be called through the MCP protocol:
### Compression Tool (compress)
Compress local files or directories into a ZIP file.
Parameters:
input: Path of the file or directory to be compressed (string or string array)
output: Path of the output ZIP file
options: Compression options (optional)
level: Compression level (0-9, default is 5)
password: Password protection
encryptionStrength: Encryption strength (1-3)
overwrite: Whether to overwrite existing files (boolean)
Returns:
Success: Text content containing success information
Failure: Text content containing error information
### Decompression Tool (decompress)
Decompress local ZIP files to the specified directory. Entry paths are validated before writing so files cannot be extracted outside output via .. or absolute paths.
Parameters:
input: Path of the ZIP file
output: Path of the output directory
options: Decompression options (optional)
password: Decompression password