Readonly Filesystem MCP

🚀 Read-only File System MCP Server

A Node.js-based server implementing the Model Context Protocol (MCP) for read-only file operations. This server is cloned from modelcontextprotocol/server-filesystem.

🚀 Quick Start

This server is a Node.js implementation of the Model Context Protocol (MCP) for read-only file operations. It is cloned from the specified GitHub repository.

✨ Features

• Read files
• List directories
• Search for files
• Get file metadata

⚠️ Important Note

The server only allows operations within the directories specified via args.

📚 Documentation

API

Resources

• file://system: File system operation interface

Tools

• read_file

  • Read the full content of a file.
  • Input:
    • path (string): The path of the file to read.
    • from (number): Optional. The line number to start reading from. Defaults to 0.
    • to (number): Optional. The end line number. If not set, reads to the end of the file.
  • Reads the file content (full or partial) in UTF-8 encoding.

• read_multiple_files

  • Read multiple files simultaneously.
  • Input: paths (array of strings).
  • A failed read does not terminate the entire operation.

• list_directory

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

• search_files

  • Recursively search for files/directories.
  • Input:
    • path (string): The starting directory.
    • pattern (string): The search pattern.
    • excludePatterns (array of strings): Exclude any matching patterns. Supports glob format.
  • Case-insensitive matching.
  • Returns the full matching paths.

• get_file_info

  • Get detailed metadata of a file/directory.
  • Input: path (string).
  • Returns:
    • Size
    • Creation time
    • Modification time
    • Access time
    • Type (file/directory)
    • Permissions

• list_allowed_directories

  • List all directories that the server is allowed to access.
  • No input required.
  • Returns:
    • The directories that the server can read/write.

💻 Usage Examples

Using with Claude Desktop

Add the following to your claude_desktop_config.json:

💡 Usage Tip

You can provide restricted directories to the server by mounting directories to /projects. Adding the ro flag makes the server access the directory in read-only mode.

NPX

{
  "mcpServers": {
    "filesystem": {
      "command": "npx",
      "args": [
        "-y",
        "@danielsuguimoto/readonly-server-filesystem",
        "/Users/username/Desktop",
        "/path/to/other/allowed/dir"
      ]
    }
  }
}

📄 License

This MCP server is distributed 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, see the LICENSE file in the project repository.