Secure Filesystem

🚀 File System MCP Server

A server for the Model Context Protocol (MCP) of file system operations implemented in Node.js, which provides a series of interfaces for file and directory operations.

🚀 Quick Start

This server is implemented in Node.js and provides a series of interfaces for file and directory operations. It only allows operations within the directory specified by args.

✨ Features

• Read/write files
• Create/list/delete directories
• Move files/directories
• Search for files
• Get file metadata

⚠️ Important Note

This server only allows operations within the directory specified by args.

📚 Documentation

Resources

• file://system: File system operation interface

Tools

• read_file

  • Read the complete content of a file.
  • Input: path (string)
  • Read the entire file content using UTF - 8 encoding.

• read_multiple_files

  • Read multiple files simultaneously.
  • Input: paths (array of strings)
  • Failed reads do not stop the entire operation.

• write_file

  • Create a new file or overwrite an existing file (use this feature with caution).
  • Input:
    • path (string): File path
    • content (string): File content

• edit_file

  • Perform selective editing using advanced pattern matching and formatting.
  • Functions:
    • Multi - line content matching based on lines
    • Standardize inter - line whitespace while preserving indentation
    • Fuzzy matching with confidence scores
    • Perform multiple edits simultaneously and locate correctly
    • Detect and preserve indentation styles
    • Provide Git - style context diff output
    • Use the dry - run mode to preview changes
    • Debug failed matches through confidence scores
  • Input:
    • path (string): File to be edited
    • edits (array): List of edit operations
      • oldText (string): Text to search for (can be a substring)
      • newText (string): Text to replace with
    • dryRun (boolean): Preview changes without applying (default: false)
    • options (object): Optional formatting settings
      • preserveIndentation (boolean): Preserve existing indentation (default: true)
      • normalizeWhitespace (boolean): Standardize whitespace while preserving structure (default: true)
      • partialMatch (boolean): Enable fuzzy matching (default: true)
  • Return detailed diff and match information (during dry - run), otherwise apply changes.
  • Best practice: Always preview changes using the dry - run mode first, then apply them.

• create_directory

  • Create a new directory or ensure its existence.
  • Input: path (string)
  • Create parent directories if necessary.
  • If the directory already exists, succeed silently.

• list_directory

  • List directory contents with [FILE] or [DIR] prefixes.
  • Input: path (string)

• move_file

  • Move or rename files and directories.
  • Input:
    • source (string)
    • destination (string)
  • Overwrite the destination path if it exists.

• search_files

  • Search for files containing specified content in a given directory.
  • Input:
    • directory (string): Directory to search in
    • content (string): Content to search for
  • Return a list of all matching files.

• delete_file

  • Delete a file at the specified path.
  • Input: path (string)

💻 Usage Examples

Basic Usage

Docker Build

docker build -t mcp/filesystem -f src/filesystem/Dockerfile .

Advanced Usage

Docker Deployment Example

# Assume this is the content of the Dockerfile
FROM node:16

WORKDIR /app

COPY package*.json ./

RUN npm install

COPY . .

CMD ["node", "index.js"]

MCP Server Configuration

// Assume this is a configuration file
const config = {
  port: 3000,
  allowedDirectories: ['/path/to/directory1', '/path/to/directory2'],
  logging: true,
  maxFileSize: '1MB'
};

📄 License

This MCP server is released 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 refer to the LICENSE file in the project repository.