{"id":26641089,"url":"https://github.com/7gugu/zip-mcp","last_synced_at":"2025-07-11T16:39:57.171Z","repository":{"id":283957786,"uuid":"953315790","full_name":"7gugu/zip-mcp","owner":"7gugu","description":"An MCP tool that provides AI with the ability to compress and decompress local files.","archived":false,"fork":false,"pushed_at":"2025-04-03T07:13:43.000Z","size":69,"stargazers_count":9,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-18T13:14:54.153Z","etag":null,"topics":["claude","compression","cursor","local","mcp","mcp-server","zip"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/zip-mcp","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/7gugu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-23T04:11:39.000Z","updated_at":"2025-04-13T02:12:33.000Z","dependencies_parsed_at":"2025-06-01T18:03:31.613Z","dependency_job_id":"e063247c-86a6-4ca3-a60b-718a4e6e84c4","html_url":"https://github.com/7gugu/zip-mcp","commit_stats":null,"previous_names":["7gugu/zip-mcp"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/7gugu/zip-mcp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/7gugu%2Fzip-mcp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/7gugu%2Fzip-mcp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/7gugu%2Fzip-mcp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/7gugu%2Fzip-mcp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/7gugu","download_url":"https://codeload.github.com/7gugu/zip-mcp/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/7gugu%2Fzip-mcp/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261984649,"owners_count":23240303,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["claude","compression","cursor","local","mcp","mcp-server","zip"],"created_at":"2025-03-24T18:19:43.670Z","updated_at":"2025-06-26T02:04:46.015Z","avatar_url":"https://github.com/7gugu.png","language":"TypeScript","funding_links":[],"categories":["File Systems","Data Labeling and Annotation","🌐 Web Development","Developer Tools Mcp Servers"],"sub_categories":["How to Submit"],"readme":"# ZIP MCP Server\n\n[中文](README_CN.md) | English\n\n## Project Introduction\n\n\u003ca href=\"https://glama.ai/mcp/servers/@7gugu/zip-mcp\"\u003e\n  \u003cimg width=\"380\" height=\"200\" src=\"https://glama.ai/mcp/servers/@7gugu/zip-mcp/badge\" /\u003e\n\u003c/a\u003e\n\nZIP 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.\n\n## Features\n\n- Supports compression and decompression of files and data\n- Supports multi-file packaging compression\n- Provides compression level control (0-9)\n- Supports password protection and encryption strength settings\n- Provides query function for compressed package metadata\n\n## Project Structure\n\n```bash\nzip-mcp\n├── src\n│   ├── index.ts               # Application entry point\n│   ├── utils\n│   │   └── compression.ts     # Compression and decompression implementation\n├── tsconfig.json              # TypeScript configuration file\n├── package.json               # npm configuration file\n└── README.md                  # Project documentation\n```\n\n## Installation\n\nYou can install ZIP MCP Server globally using npm:\n\n```bash\nnpm install -g zip-mcp\n```\n\n## MCP Configuration\n\nAfter installation, you can configure ZIP MCP in your MCP JSON configuration:\n\n```json\n{\n  \"mcpServers\": {\n    \"zip-mcp\": {\n      \"command\": \"zip-mcp\",\n      \"args\": []\n    }\n  }\n}\n```\n\n## Configure the MCP JSON in the AI Client\n\n- Claude Client: [https://modelcontextprotocol.io/quickstart/user](https://modelcontextprotocol.io/quickstart/user)\n- Raycast: requires installing the MCP plugin\n- Cursor: [https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers](https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers)\n\n## MCP Tool Description\n\nZIP MCP Server provides the following tools, which can be called through the MCP protocol:\n\n### Compression Tool (compress)\n\nCompress local files or directories into a ZIP file.\n\n**Parameters:**\n\n- `input`: Path of the file or directory to be compressed (string or string array)\n- `output`: Path of the output ZIP file\n- `options`: Compression options (optional)\n  - `level`: Compression level (0-9, default is 5)\n  - `password`: Password protection\n  - `encryptionStrength`: Encryption strength (1-3)\n  - `overwrite`: Whether to overwrite existing files (boolean)\n\n**Returns:**\n\n- Success: Text content containing success information\n- Failure: Text content containing error information\n\n### Decompression Tool (decompress)\n\nDecompress local ZIP files to the specified directory.\n\n**Parameters:**\n\n- `input`: Path of the ZIP file\n- `output`: Path of the output directory\n- `options`: Decompression options (optional)\n  - `password`: Decompression password\n  - `overwrite`: Whether to overwrite existing files (boolean)\n  - `createDirectories`: Whether to create non-existent directories (boolean)\n\n**Returns:**\n\n- Success: Text content containing decompression result information\n- Failure: Text content containing error information\n\n### ZIP Info Tool (getZipInfo)\n\nGet metadata information of local ZIP files.\n\n**Parameters:**\n\n- `input`: Path of the ZIP file\n- `options`: Options (optional)\n  - `password`: Decompression password\n\n**Returns:**\n\n- Success: Text content containing detailed information of the ZIP file, including:\n  - Total number of files\n  - Total size\n  - Compressed size\n  - Compression ratio\n  - Detailed information of each file\n- Failure: Text content containing error information\n\n### Test Tool (echo)\n\nReturns the input message to test if the service is running normally.\n\n**Parameters:**\n\n- `message`: Message to be returned\n\n**Returns:**\n\n- Text content containing the input message and current timestamp\n\n## Examples\n\nExamples of calling tools using the MCP client:\n\n```javascript\n// Compress files\nawait client.executeTool(\"compress\", {\n  input: \"/path/to/files/or/directory\",\n  output: \"/path/to/output.zip\",\n  options: {\n    level: 9,\n    comment: \"Test compression\",\n    password: \"secret\",\n    overwrite: true,\n  },\n});\n\n// Decompress files\nawait client.executeTool(\"decompress\", {\n  input: \"/path/to/archive.zip\",\n  output: \"/path/to/extract/directory\",\n  options: {\n    password: \"secret\",\n    overwrite: true,\n    createDirectories: true,\n  },\n});\n\n// Get ZIP info\nawait client.executeTool(\"getZipInfo\", {\n  input: \"/path/to/archive.zip\",\n  options: {\n    password: \"secret\",\n  },\n});\n\n// Test service\nawait client.executeTool(\"echo\", {\n  message: \"Hello, ZIP MCP Server!\",\n});\n```\n\n## Contact\n\n- Email: [gz7gugu@qq.com](mailto:gz7gugu@qq.com)\n- Blog: [https://7gugu.com](https://7gugu.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F7gugu%2Fzip-mcp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F7gugu%2Fzip-mcp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F7gugu%2Fzip-mcp/lists"}