Mcp7zOp

Mcp7zOp - A Local MCP server for operating 7-zip CUI interface

<!-- TOC tocDepth:2..4 chapterDepth:2..6 -->

• 1. Overview
• 2. Features
  • 2-1. Archive Operations
  • 2-2. File System Operations
• 3. Requirements
  • 3-1. System Requirements
  • 3-2. 7-Zip Installation
• 4. Usage
  • 4-1. Running as MCP Server
  • 4-2. Building Package
  • 4-3. Available Tools
    • mcp7zop_make_archive
    • mcp7zop_extract_archive
    • mcp7zop_get_archive_item_list
    • mcp7zop_replace_archive_items
    • mcp7zop_remove_archive_items
    • mcp7zop_get_dir_item_list
    • mcp7zop_get_path_item_info
    • mcp7zop_path_is_exist
• License

<!-- /TOC -->

1. Overview

Mcp7zOp is an MCP (Model Context Protocol) server for 7-Zip archive operations.
It provides tools for file and directory archive creation, extraction, and file system operations.

2. Features

2-1. Archive Operations

Uses the installed 7-Zip to perform the following operations:

• Archive Creation: Create 7z or zip archives from multiple files and directories
• Archive Extraction: Extract 7z or zip archives to a specified directory
• Archive Item Listing: Get a list of items in an archive file
• Archive Item Addition/Replacement: Add or replace files and directories in existing archives
• Archive Item Removal: Remove specified items from archives

2-2. File System Operations

Some environments may not allow file listing for folders outside the open project, so the following file system reference functions necessary for archive creation are also provided:

• Directory Listing: Get a list of items in a specified directory
• Path Information: Get detailed information about files or directories
• Path Existence Check: Check if a specified path exists

3. Requirements

3-1. System Requirements

• Python 3.10 or higher
• 7-Zip

3-2. 7-Zip Installation

Please download and install 7-Zip from the official website.

• 7-Zip Official Website

After installing 7-Zip using the installer, please set up the 7-Zip path using one of the following methods:

a. Make the 7z command available

Add the directory containing the 7-Zip executable to your system's PATH environment variable.

b. Use a configuration file

Create a ${HOME}/.mcp7zop/config.json file and specify the path to 7-Zip.

{
    "7z_path": "/path/to/7z"
}

4. Usage

This project uses uv as the package manager.

4-1. Running as MCP Server

Use the uv run command specifying the project directory to execute.

uv run (--directory {path_to_project_dir}) -m mcp7zop --mcp-server

If you have installed the module package in your Python environment, you can run it as follows:

python -m mcp7zop --mcp-server

4-2. Building Package

You can generate a package using the build command.

uv build

4-3. Available Tools

mcp7zop_make_archive

Creates an archive from multiple files and directories.

Parameters:

• archive_path (str): Path of the archive file to be created
• input_pathes (List[str]): List of file/directory paths to include in the archive

Returns: Path of the created archive file

mcp7zop_extract_archive

Extracts an archive file.

Parameters:

• archive_path (str): Path of the archive file to extract
• extract_dir (str): Directory where files will be extracted

Returns: List of extracted file paths

mcp7zop_get_archive_item_list

Gets a list of items in an archive file.

Parameters:

• archive_path (str): Path of the archive file to list items from

Returns: List of dictionaries containing item information

mcp7zop_replace_archive_items

Adds or replaces files and directories in an archive.

Parameters:

• archive_path (str): Path of the archive file to be updated
• replace_pathes (List[str]): List of file/directory paths to add or replace in the archive

Returns: Path of the updated archive file

mcp7zop_remove_archive_items

Removes specified items from an archive.

Parameters:

• archive_path (str): Path of the archive file to remove items from
• remove_item_paths (List[str]): List of item paths to be removed from the archive

Returns: Path of the updated archive file

mcp7zop_get_dir_item_list

Gets a list of items in a directory.

Parameters:

• dir_path (str): Path of the directory to list

Returns: List of dictionaries containing item names and types

mcp7zop_get_path_item_info

Gets detailed information about a path.

Parameters:

• item_path (str): Path of the item to get information about

Returns: Dictionary containing item information

mcp7zop_path_is_exist

Checks if a path exists.

Parameters:

• item_path (str): Path to check

Returns: True if the path exists, False otherwise

---

5. License

This project is released under the MIT License.
See the LICENSE file for details.