rust -filesystem

Rust MCP Filesystem is a fast, asynchronous server for handling filesystem operations via the MCP protocol. It runs as a standalone Rust binary (or from its Docker image) and provides a read/write-capable interface once configured. The server emphasizes a read-only-by-default posture for safety, with optional write access that can be enabled through configuration. Core capabilities include advanced glob-based file search to filter files and directories, dynamic MCP Roots management to control which directories are available to clients, and built-in ZIP tooling to create archives or extract them from provided paths. When deployed in a container or as a binary, you can interact with its capabilities through the MCP protocol, invoking tools and operations defined under the filesystem capabilities page of the project documentation. The project leverages the rust-mcp-sdk and rust-mcp-schema, offering a type-safe, performant implementation with a focus on filesystem exploration, automation, and integration workflows.

Prerequisites:

• Docker (recommended for quick setup) or a Rust toolchain if you prefer building from source and running the binary directly.
• Access to the internet to pull binaries/images or to fetch dependencies.

Installation options:

Option 1: Docker (fastest, no local build required)

1. Ensure Docker is installed and running.
2. Pull and run the Docker image: docker run -it --rm mcp/server/rust-mcp-filesystem
3. Configure runtime options via environment variables or mounted config if supported by the image (refer to documentation for env var names).

Option 2: Prebuilt binaries (local run)

1. Download the appropriate binary for your OS from the releases page: https://github.com/rust-mcp-stack/rust-mcp-filesystem/releases
2. Unpack and run the binary: chmod +x rust-mcp-filesystem ./rust-mcp-filesystem
3. If you need to customize, provide a configuration file or environment-based overrides as documented in the project docs.

Option 3: Homebrew (macOS/Linux)

1. Ensure Homebrew is installed.
2. Install the package: brew install rust-mcp-stack/tap/rust-mcp-filesystem
3. Run the binary via the installed path as documented in the docs.

Option 4: NPM package (optional convenience wrapper)

1. Install globally: npm i -g @rustmcp/rust-mcp-filesystem@latest
2. Run the tool through the installed binary wrapper as described in the package docs.

Notes:

• The project docs provide exact environment variables and config guidelines; consult the documentation for production deployments and security considerations.
• If using Docker, consider mounting a configuration directory and exposing necessary ports as required by your MCP client.

Tips and common issues:

• Read-Only by default: If you need write access, explicitly enable it in configuration to avoid accidental modifications.
• Glob capabilities: Use standard glob patterns like .rs, src/**/.txt, and logs/error-???.log to filter results; test patterns with small samples before applying to large directories.
• ZIP support: Use the built-in ZIP tooling to quickly archive or extract content as part of your automation pipelines.
• MCP Roots: By default, roots are disabled; enable and configure allowed directories according to your security and access requirements.
• Environment variables: Check the docs for required or optional env vars (e.g., root paths, enable flags, and access controls) to tailor the server behavior for your environment.
• Logs and observability: Enable verbose logs during initial setup to verify capabilities and correct configuration. Ensure your deployment environment has sufficient permissions for filesystem access and archive operations.