Filesystem MCP Server

Node.js server implementing Model Context Protocol (MCP) for filesystem operations.

Features

• Read/write files

• Create/list/delete directories

• Move files/directories

• Search files

• Get file metadata

• Dynamic directory access control via Roots

Directory Access Control

The server uses a flexible directory access control system. Directories can be specified via command-line arguments or dynamically via Roots.

Method 1: Command-line Arguments

Specify Allowed directories when starting the server:

Method 2: MCP Roots (Recommended)

MCP clients that support Roots can dynamically update the Allowed directories.

Roots notified by Client to Server, completely replace any server-side Allowed directories when provided.

Important: If server starts without command-line arguments AND client doesn't support roots protocol (or provides empty roots), the server will throw an error during initialization.

This is the recommended method, as this enables runtime directory updates via roots/list_changed notifications without server restart, providing a more flexible and modern integration experience.

How It Works

The server's directory access control follows this flow:

1. Server Startup

   • Server starts with directories from command-line arguments (if provided)

   • If no arguments provided, server starts with empty allowed directories

2. Client Connection & Initialization

   • Client connects and sends initialize request with capabilities

   • Server checks if client supports roots protocol (capabilities.roots)

3. Roots Protocol Handling (if client supports roots)

   • On initialization: Server requests roots from client via roots/list

   • Client responds with its configured roots

   • Server replaces ALL allowed directories with client's roots

   • On runtime updates: Client can send notifications/roots/list_changed

   • Server requests updated roots and replaces allowed directories again

4. Fallback Behavior (if client doesn't support roots)

   • Server continues using command-line directories only

   • No dynamic updates possible

5. Access Control

   • All filesystem operations are restricted to allowed directories

   • Use list_allowed_directories tool to see current directories

   • Server requires at least ONE allowed directory to operate

Note: The server will only allow operations within directories specified either via args or via Roots.

API

Tools

• read_text_file

  • Read complete contents of a file as text

  • Inputs:

    • path (string)

    • head (number, optional): First N lines

    • tail (number, optional): Last N lines

    • stream (boolean, optional): Stream large files in chunks (default: false)

  • Always treats the file as UTF-8 text regardless of extension

  • Cannot specify both head and tail simultaneously

• read_media_file

  • Read an image or audio file

  • Inputs:

    • path (string)

  • Streams the file and returns base64 data with the corresponding MIME type

• read_multiple_files

  • Read multiple files simultaneously

  • Input: paths (string[])

  • Failed reads won't stop the entire operation

• write_file

  • Create new file, overwrite existing, or append to existing

  • Inputs:

    • path (string): File location

    • content (string): File content

    • append (boolean, optional): If true, append to file instead of overwriting (default: false)

• edit_file

  • Make selective edits using advanced pattern matching and formatting

  • Features:

    • Line-based and multi-line content matching

    • Whitespace normalization with indentation preservation

    • Multiple simultaneous edits with correct positioning

    • Indentation style detection and preservation

    • Git-style diff output with context

    • Preview changes with dry run mode

  • Inputs:

    • path (string): File to edit

    • edits (array): List of edit operations

      • oldText (string): Text to search for (can be substring or regex pattern)

      • newText (string): Text to replace with

      • useRegex (boolean, optional): If true, treat oldText as regex pattern

      • flags (string, optional): Regex flags (e.g., 'g', 'i', 'm')

    • dryRun (boolean): Preview changes without applying (default: false)

  • Returns detailed diff and match information for dry runs, otherwise applies changes

  • Best Practice: Always use dryRun first to preview changes before applying them

• create_directory

  • Create new directory or ensure it exists

  • Input: path (string)

  • Creates parent directories if needed

  • Succeeds silently if directory exists

• list_directory

  • List directory contents with [FILE] or [DIR] prefixes

  • Input: path (string)

• list_directory_with_sizes

  • List directory contents with [FILE] or [DIR] prefixes, including file sizes

  • Inputs:

    • path (string): Directory path to list

    • sortBy (string, optional): Sort entries by "name", "size", "mtime", or "atime" (default: "name")

  • Returns detailed listing with file sizes and summary statistics

  • Shows total files, directories, and combined size

• move_file

  • Move or rename files and directories

  • Inputs:

    • source (string)

    • destination (string)

  • Fails if destination exists

• search_files

  • Recursively search for files/directories that match or do not match patterns

  • Inputs:

    • path (string): Starting directory

    • pattern (string): Search pattern

    • excludePatterns (string[]): Exclude any patterns.

    • caseSensitive (boolean, optional): Case-sensitive matching (default: false)

    • maxDepth (number, optional): Maximum search depth

    • fileTypes (string[], optional): Filter by file extensions (e.g., ['.ts', '.js'])

  • Glob-style pattern matching

  • Returns full paths to matches

• file_compare

  • Compare two files and return the differences in unified diff format

  • Inputs:

    • path1 (string): Path to the first file

    • path2 (string): Path to the second file

  • Returns unified diff showing additions, deletions, and context

• file_backup

  • Create a backup of a file

  • Inputs:

    • path (string): Path to the file to backup

    • backupPath (string, optional): Backup path, defaults to original with .bak extension

  • Creates a copy of the file

• compress_file

  • Compress a file using gzip

  • Inputs:

    • path (string): Path to the file to compress

    • outputPath (string, optional): Output path, defaults to original with .gz extension

  • Creates a compressed version of the file

• file_hash

  • Calculate hash of a file

  • Inputs:

    • path (string): Path to the file

    • algorithm (string, optional): Hash algorithm (md5, sha1, sha256, sha512), default sha256

  • Returns the hash value

• file_merge

  • Merge multiple files into one

  • Inputs:

    • paths (string[]): Array of file paths to merge (at least 2)

    • outputPath (string): Path for the merged file

    • separator (string, optional): Separator between files, default newline

  • Combines files in order

• directory_tree

  • Get recursive JSON tree structure of directory contents

  • Inputs:

    • path (string): Starting directory

    • excludePatterns (string[]): Exclude any patterns. Glob formats are supported.

  • Returns:

    • JSON array where each entry contains:

      • name (string): File/directory name

      • type ('file'|'directory'): Entry type

      • children (array): Present only for directories

        • Empty array for empty directories

        • Omitted for files

  • Output is formatted with 2-space indentation for readability

• get_file_info

  • Get detailed file/directory metadata

  • Input: path (string)

  • Returns:

    • Size

    • Creation time

    • Modified time

    • Access time

    • Type (file/directory)

    • Permissions

• list_allowed_directories

  • List all directories the server is allowed to access

  • No input required

  • Returns:

    • Directories that this server can read/write from

Usage with Claude Desktop

Add this to your claude_desktop_config.json:

Note: you can provide sandboxed directories to the server by mounting them to /projects. Adding the ro flag will make the directory readonly by the server.

Docker

Note: all directories must be mounted to /projects by default.

NPX

Usage with VS Code

For quick installation, click the installation buttons below...

For manual installation, you can configure the MCP server using one of these methods:

Method 1: User Configuration (Recommended) Add the configuration to your user-level MCP configuration file. Open the Command Palette (Ctrl + Shift + P) and run MCP: Open User Configuration. This will open your user mcp.json file where you can add the server configuration.

Method 2: Workspace Configuration Alternatively, you can add the configuration to a file called .vscode/mcp.json in your workspace. This will allow you to share the configuration with others.

For more details about MCP configuration in VS Code, see the official VS Code MCP documentation.

You can provide sandboxed directories to the server by mounting them to /projects. Adding the ro flag will make the directory readonly by the server.

Docker

Note: all directories must be mounted to /projects by default.

NPX

Build

Docker build:

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.