What is File System Mcp Sse

file-system-mcp-sse is a Node.js server implementing the Model Context Protocol (MCP) for filesystem operations, enabling various file and directory manipulations.

Use cases

Use cases include automated file processing, collaborative editing of configuration files, batch file operations, and implementing file search functionalities in applications.

How to use

To use file-system-mcp-sse, you can interact with its API through specified resources like ‘file://system’, utilizing tools for reading, writing, editing files, and managing directories.

Key features

Key features include reading/writing files, creating/listing/deleting directories, moving files/directories, searching for files, and retrieving file metadata. Operations are restricted to specified directories.

Where to use

file-system-mcp-sse can be used in software development environments, file management systems, and applications requiring dynamic file operations and directory management.

Filesystem MCP Server SSE

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

Features

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

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

API

Resources

• file://system: File system operations interface

Tools

• read_file

  • Read complete contents of a file
  • Input: path (string)
  • Reads complete file contents with UTF-8 encoding

• read_multiple_files

  • Read multiple files simultaneously
  • Input: paths (string[])
  • Failed reads won’t stop the entire operation

• write_file

  • Create new file or overwrite existing (exercise caution with this)
  • Inputs:
    • path (string): File location
    • content (string): File content

• 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)
      • newText (string): Text to replace with
    • 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)

• move_file

  • Move or rename files and directories
  • Inputs:
    • source (string)
    • destination (string)
  • Fails if destination exists

• search_files

  • Recursively search for files/directories
  • Inputs:
    • path (string): Starting directory
    • pattern (string): Search pattern
    • excludePatterns (string[]): Exclude any patterns. Glob formats are supported.
  • Case-insensitive matching
  • Returns full paths to matches

• 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

Run & Usage

Local

1. build:

npm install

2.1 run Windows:

node .\dist\index.js C:\Users\User

allowed directories: C:\Users\User

2.2 run Macos / Linux:

node ./dist/index.js /Users

allowed directories: /Users

3. config:

{
  "mcpServers": {
    "file_system": {
      "name": "file_system",
      "baseUrl": "http://127.0.0.1:3001/sse"
    }
  }
}

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.