chuk-mcp-virtual-fs
MCP (Mission Control Platform) server for the Virtual FileSystem. This package provides a set of tools for managing files and directories in a virtual filesystem through the MCP framework.
Features
- File and directory operations (create, read, write, delete, copy, move)
- Directory listing and file searching
- Filesystem snapshot management (create, restore, export, import)
- Storage statistics
- Support for different storage backends through Virtual FileSystem (local, S3, etc.)
Installation
pip install chuk-mcp-virtual-fs
Configuration
Create a config.yaml file with the following settings:
host:
name: "chuk-mcp-virtual-fs"
log_level: "INFO"
server:
type: "stdio" # or "websocket" for network-based communication
mcp_servers:
virtual_fs:
enabled: true
location: "."
tools:
enabled: true
module: "chuk_mcp_virtual_fs.tools"
Environment Variables
The following environment variables can be set to configure the virtual filesystem:
For S3 Provider
VIRTUAL_FS_PROVIDER: Set to "s3" to use S3 storage (default if not specified)S3_BUCKET_NAME: Name of the S3 bucket to useS3_PREFIX: Prefix for all files within the bucketAWS_ENDPOINT_URL_S3: Custom endpoint URL for S3-compatible storageAWS_REGION: AWS region to use
For Local Provider
VIRTUAL_FS_PROVIDER: Set to "local" to use local filesystemLOCAL_FS_ROOT: Root directory for the local filesystem
For Memory Provider
VIRTUAL_FS_PROVIDER: Set to "memory" to use in-memory filesystemMEMORY_FS_ID: Optional identifier for the memory filesystem (defaults to "default")
Usage
Start the MCP server:
mcp-virtual-fs
Then use the MCP client to interact with the virtual filesystem tools.
Available Tools
list_directory: List contents of a directoryread_file: Read file contentwrite_file: Write content to a filemkdir: Create a directorydelete: Delete a file or directorycopy: Copy a file or directorymove: Move a file or directoryfind: Find files matching a patternget_storage_stats: Get storage statisticscreate_snapshot: Create a filesystem snapshotrestore_snapshot: Restore from a filesystem snapshotlist_snapshots: List available snapshotsexport_snapshot: Export a snapshot to a fileimport_snapshot: Import a snapshot from a file
Development
Prerequisites
- Python 3.11 or higher
- Required packages: boto3, pydantic, chuk-mcp-runtime, mcp, chuk-virtual-fs
Setup Development Environment
- Clone the repository
- Install development dependencies:
pip install -e ".[dev]"
- Run tests:
pytest
License
Metadata
Release files for chuk-mcp-virtual-fs 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| chuk_mcp_virtual_fs-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for chuk_mcp_virtual_fs-0.1.0-py3-none-any.whl |
Release files / chuk_mcp_virtual_fs-0.1.0-py3-none-any.whl
| Download URL | chuk_mcp_virtual_fs-0.1.0-py3-none-any.whl |
|---|---|
| Size | 10.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a9f0e550dab112454665f24007879963e023307c55b73576b598ebba9ca41f4d
|
|
BLAKE2b-256 checksum How to use checksums |
663d867b78b65369d050af19598149f728f630749cb9149233a205600322cd51
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.2
|
Security for chuk-mcp-virtual-fs 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.