Zip MCP

🚀 ZIP MCP Server

The ZIP MCP Server is a compression server for the Model Context Protocol (MCP) based on fastMCP and zip.js, offering full parameter - controlled ZIP file compression, decompression, and querying of archive information.

🚀 Quick Start

The ZIP MCP Server is a compression server for the Model Context Protocol (MCP) implemented with fastMCP and zip.js. It provides functions for compressing, decompressing ZIP files, and querying archive information with full parameter control.

✨ Features

• Support for compressing and decompressing files and data.
• Support for packaging and compressing multiple files.
• Compression level control (0 - 9).
• Support for password protection and encryption strength settings.
• Function to query archive metadata.

📦 Installation

Globally install the ZIP MCP Server using npm:

npm install -g zip-mcp

📚 Documentation

Project Structure

zip-mcp
├── src
│   ├── index.ts               # Application entry file
│   ├── utils
│   │   └── compression.ts     # File for compression and decompression implementation
├── tsconfig.json              # TypeScript configuration file
├── package.json               # npm configuration file
└── README.md                  # Project documentation

MCP Configuration

After installation, you can configure ZIP MCP in the MCP JSON configuration:

{
  "mcpServers": {
    "zip-mcp": {
      "command": "zip-mcp",
      "args": []
    }
  }
}

AI Client MCP JSON Configuration

• For Claude Client, refer to: https://modelcontextprotocol.io/quickstart/user
• For Raycast, you need to install the MCP plugin.
• For Cursor, refer to: https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers

MCP Tool Description

The ZIP MCP Server provides the following tools, which can be called via 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 array of strings).
• 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).

Return:

• Success: Text content containing success information.
• Failure: Text content containing error information.

Decompression Tool (decompress)

Decompress a local ZIP file to a specified directory.

Parameters:

• input: Path of the ZIP file to be decompressed.
• output: Path of the output decompression directory.
• options: Decompression options (optional).
  • password: Decompression password.
  • overwrite: Whether to overwrite existing files (boolean).
  • createDirectories: Whether to create sub - directories (boolean).

Return:

• Success: Text content containing success information.
• Failure: Text content containing error information.

Query Tool (query)

Query the file list inside an archive.

Parameters:

• input: Path of the ZIP file to be queried.
• options: Query options (optional).
  • password: Decryption password (if decryption is required).

Return:

• Success: Text content containing the file list.
• Failure: Text content containing error information.

Example Calls

// Compression example
await client.executeTool("zip-mcp/compress", {
  input: ["./files/to_compress/*"],
  output: "./compressed.zip",
  options: {
    level: 9,
    password: "yourpassword"
  }
});

// Decompression example
await client.executeTool("zip-mcp/decompress", {
  input: "./compressed.zip",
  output: "./extracted_files",
  options: {
    password: "yourpassword"
  }
});

// Query example
await client.executeTool("zip-mcp/query", {
  input: "./compressed.zip",
  options: {
    password: "yourpassword"
  }
});

📄 Contact

• Email: gz7gugu@qq.com
• Blog: https://7gugu.com