Filesystem

🚀 File System MCP Server

A Model Context Protocol (MCP) server that provides file system operations for Claude AI.

🚀 Quick Start

The File System MCP Server offers a range of file system operations for Claude AI. To get started, follow the installation steps and use the provided commands to run the server and configure it in your MCP setup.

✨ Features

This MCP server provides the following file system operations:

1. Read File: Read the entire content of a file.

   • Input: path (string)
   • Read the full file content using UTF-8 encoding.

2. Read Multiple Files: Read multiple files simultaneously.

   • Input: paths (array of strings)
   • Failed reads do not halt the entire operation.

3. Write File: Create a new file or overwrite an existing one.

   • Input:
     • path (string): File location.
     • content (string): File content.

4. Create Directory: Create a new directory or ensure its existence.

   • Input: path (string)
   • Create parent directories if necessary.
   • Succeed silently if the directory already exists.

5. List Directory Contents: List directory contents with [FILE] or [DIR] prefixes.

   • Input: path (string)

6. Move File: Move or rename files and directories.

   • Input:
     • source (string)
     • destination (string)
   • Fail if the destination exists.

7. Search Files: Recursively search for files/directories.

   • Input:
     • path (string): Starting directory.
     • pattern (string): Search pattern.
   • Perform case-insensitive matching.
   • Return full matching paths.

8. Get File Information: Get detailed metadata of a file/directory.

   • Input: path (string)
   • Return:
     • Size
     • Creation time
     • Modification time
     • Access time
     • Type (file/directory)
     • Permissions

9. List Allowed Directories: List all directories the server can access.

   • No input required.
   • Return directories the server can read/write.

🔒 Security

The server only allows operations within directories specified via command-line arguments.

📦 Installation

1. Clone this repository.
2. Install dependencies: npm install
3. Build the project: npm run build

💻 Usage Examples

Basic Usage

Run the server using the following command:

node build/index.js /path/to/allowed/dir1 /path/to/allowed/dir2

MCP Configuration

Add the server to your MCP configuration file:

{
  "mcpServers": {
    "filesystem-server": {
      "command": "node",
      "args": [
        "/path/to/filesystem-server/build/index.js",
        "/path/to/allowed/dir1",
        "/path/to/allowed/dir2"
      ],
      "disabled": false,
      "autoApprove": []
    }
  }
}

📄 License

ISC