使用说明
Filesystem MCP Server
Node.js server implementing Model Context Protocol (MCP) for filesystem operations.
Published on npm as @modelcontextprotocol/server-filesystem.
Features
- Read/write files
- Create/list/delete directories
- Move files/directories
- Search files
- Get file metadata
- Directory access control from command-line arguments, with Roots as a deprecated, 2025-era convenience
- Serves both protocol eras on stdio: 2026-07-28 clients (
server/discover, no handshake) and 2025-era clients (initialize)
Directory Access Control
The server may touch only its allowed directories. Pass them on the command line. A 2025-era client that supports Roots can also replace them at runtime, but Roots is deprecated as of protocol version 2026-07-28 and a 2026-07-28 connection cannot use it.
Method 1: Command-line Arguments (Recommended)
Specify Allowed directories when starting the server:
mcp-server-filesystem /path/to/dir1 /path/to/dir2
This is the only method that works on every protocol version, so it is the one to use.
Method 2: MCP Roots (Deprecated, 2025-era clients only)
A client that connects with a 2025-era protocol version (the initialize handshake) and supports Roots can dynamically update the Allowed directories.
Roots notified by Client to Server, completely replace any server-side Allowed directories when provided.
A Root reached through a symlink is allowed in both its advertised form and its resolved form, as a command-line directory is: a Root of file:///tmp/project on macOS allows /tmp/project and /private/tmp/project. Every requested path is still resolved and checked against the resolved directories, so a symlink inside a Root that points outside it is refused.
Important: If server starts without command-line arguments AND a 2025-era client doesn't support roots protocol, the server fails at initialization: it logs the reason to stderr, closes the connection and exits with status 1. A client that supports roots but provides none (or none that are valid) keeps the connection, with no allowed directories until it sends roots/list_changed with valid roots.
The 2026-07-28 protocol has no initialize handshake and no server-to-client roots/list request, so a 2026-07-28 client's roots are never asked for: the command-line directories are the whole allow-list. A server started with none answers every tool call on such a connection with an error saying so.
How It Works
The server's directory access control follows this flow:
-
Server Startup
- Server starts with directories from command-line arguments (if provided)
- If no arguments provided, server starts with empty allowed directories
-
Client Connection
- The client's first message picks the protocol era of the connection
- A 2026-07-28 client sends
server/discover(or any request carrying the per-request_metaenvelope): the server uses the command-line directories, and steps 3 and 4 do not apply - A 2025-era client sends
initializewith its capabilities, and the server checks whether it supports roots (capabilities.roots)
-
Roots Protocol Handling (2025-era clients that support 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
- Tool calls that arrive before the initial roots are loaded wait for them, so they are checked against the client's roots
- On runtime updates: Client can send
notifications/roots/list_changed - Server requests updated roots and replaces allowed directories again
- Tool calls that arrive while an update is being fetched wait for it, so none runs against a root the client has just withdrawn
- Once the client's roots are in force, an update with no valid roots revokes access: every path is refused ("Access denied - no allowed directories") until the client exposes a root again. Before any root has been in force, such an update keeps the command-line directories
- On initialization: Server requests roots from client via
-
Fallback Behavior (2025-era clients that don't support roots)
- Server continues using command-line directories only
- No dynamic updates possible
- With no command-line directories either, the server logs an error, closes the connection and exits with status 1
-
Access Control
- All filesystem operations are restricted to allowed directories
- Use
list_allowed_directoriestool 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, for a 2025-era client, via Roots.
API
Tools
-
read_text_file
- Read complete contents of a file as text
- Inputs:
path(string)head(number, optional): First N linestail(number, optional): Last N lines
- Always treats the file as UTF-8 text regardless of extension
- Cannot specify both
headandtailsimultaneously
-
read_media_file
- Read a file and return it as a base64-encoded content block with its MIME type
- Inputs:
path(string)
- Streams the file and returns base64 data with the corresponding MIME type. Image and
audio files are returned as
image/audiocontent; any other file type is returned as an embeddedresource(a valid MCP content block for arbitrary binary data)
-
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 locationcontent(string): File content
- An existing file is overwritten in place, so it keeps its inode, creation
time, hard links and permissions (
edit_filewrites the same way). The overwrite is not crash-atomic: a crash mid-write can leave the file partly written. A read-only file is refused rather than replaced - Allowed-directory checks are path-based: they check the name you pass,
not every name the file has. A hard link is a real name of the same file,
so when a file inside an allowed directory is also hard-linked from
somewhere else (pnpm, for example, hard-links package files into
node_modulesfrom its store), overwriting or editing it changes the content at every name, inside the allowed directories or not.get_file_inforeports a file'shardLinkscount; more than 1 means the file has other names
-
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: when only whitespace differs, each replacement line takes the indentation of the line it replaces
- Preserves the file's line endings (LF or CRLF)
- Git-style diff output with context
- Preview changes with dry run mode
- Inputs:
path(string): File to editedits(array): List of edit operationsoldText(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)
-
list_directory_with_sizes
- List directory contents with [FILE] or [DIR] prefixes, including file sizes
- Inputs:
path(string): Directory path to listsortBy(string, optional): Sort entries by "name" or "size" (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
- Across filesystems (the source and destination on different mounts or disks), a regular file is moved by copying it to a newly created destination, with its permissions and modification time, and then removing the source. If the copy fails, the partial destination is removed and the source is left in place. A directory cannot be moved across filesystems and fails with an error; move its files one at a time instead
-
search_files
- Recursively search for files/directories that match or do not match patterns
- Inputs:
path(string): Starting directorypattern(string): Search patternexcludePatterns(string[]): Exclude any patterns. An excluded entry is skipped before it is resolved or read, so excluding a slow folder keeps the search out of it entirely.
- Glob-style pattern matching
- Returns full paths to matches
- Bounded: see Slow and very large trees
-
directory_tree
- Get recursive JSON tree structure of directory contents
- Inputs:
path(string): Starting directoryexcludePatterns(string[]): Exclude any patterns. Glob formats are supported.
- Returns:
- JSON array where each entry contains:
name(string): File/directory nametype('file'|'directory'): Entry typechildren(array): Present only for directories- Empty array for empty directories
- Omitted for files
- JSON array where each entry contains:
- Output is formatted with 2-space indentation for readability
- Bounded: see Slow and very large trees
-
get_file_info
- Get detailed file/directory metadata
- Input:
path(string) - Returns:
- Size
- Creation time
- Modified time
- Access time
- Type (file/directory)
- Permissions
- Hard-link count (
hardLinks): the number of names the file has. More than 1 means a write through this name changes the file at its other names too (seewrite_file)
-
list_allowed_directories
- List all directories the server is allowed to access
- No input required
- Returns:
- Directories that this server can read/write from. A directory reached through a symlink is listed twice, in the form it was given and in its resolved form
Slow and very large trees
A folder backed by a cloud-storage provider (macOS ~/Library/CloudStorage,
iCloud Drive) or a slow network mount can make a single filesystem call block
for minutes while the provider fetches metadata. Two fixed limits keep one
request from stalling the server:
- Resolving a path (in any tool), and each directory read in
search_filesanddirectory_tree, waits at most 15 seconds. A call that takes longer ends the request with an error naming the path (Filesystem call timed out after 15000 ms: ...). A path whose real location cannot be read in time is refused, never admitted. search_filesanddirectory_treevisit at most 100,000 entries. A walk that reaches the cap ends with an error (... stopped after visiting 100000 entries ...) rather than a partial result. Excluded entries do not count.
Either error means: narrow path, or name the slow or large folder in
excludePatterns. A timed-out call cannot be cancelled and finishes in the
background, so a provider that stalls repeatedly can still slow the server's
other file operations until it answers.
Tool annotations (MCP hints)
This server sets MCP ToolAnnotations on each tool so clients can:
- Distinguish read‑only tools from write‑capable tools.
- Understand which write operations are idempotent (safe to retry with the same arguments).
- Highlight operations that may be destructive (overwriting or heavily mutating data).
- Signal that a tool does not reach an open or external world (every filesystem tool sets
openWorldHint: false).
The mapping for filesystem tools is:
| Tool | readOnlyHint | idempotentHint | destructiveHint | Notes |
|---|---|---|---|---|
read_text_file |
true |
– | – | Pure read |
read_media_file |
true |
– | – | Pure read |
read_multiple_files |
true |
– | – | Pure read |
list_directory |
true |
– | – | Pure read |
list_directory_with_sizes |
true |
– | – | Pure read |
directory_tree |
true |
– | – | Pure read |
search_files |
true |
– | – | Pure read |
get_file_info |
true |
– | – | Pure read |
list_allowed_directories |
true |
– | – | Pure read |
create_directory |
false |
true |
false |
Re‑creating the same dir is a no‑op |
write_file |
false |
true |
true |
Overwrites existing files |
edit_file |
false |
false |
true |
Re‑applying edits can fail or double‑apply |
move_file |
false |
false |
true |
Deletes source file |
Note:
idempotentHintanddestructiveHintare meaningful only whenreadOnlyHintisfalse, as defined by the MCP spec. Every tool also setsopenWorldHint: false— this server only accesses the local filesystem within its allowed directories, never an open or external world.
Requirements
Node.js 24 or later, when the server runs through npx or from source.
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.
{
"mcpServers": {
"filesystem": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"--mount", "type=bind,src=/Users/username/Desktop,dst=/projects/Desktop",
"--mount", "type=bind,src=/path/to/other/allowed/dir,dst=/projects/other/allowed/dir,ro",
"--mount", "type=bind,src=/path/to/file.txt,dst=/projects/path/to/file.txt",
"mcp/filesystem",
"/projects"
]
}
}
}
NPX
{
"mcpServers": {
"filesystem": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-filesystem",
"/Users/username/Desktop",
"/path/to/other/allowed/dir"
]
}
}
}
On Windows, use cmd /c to launch npx:
{
"mcpServers": {
"filesystem": {
"command": "cmd",
"args": [
"/c",
"npx",
"-y",
"@modelcontextprotocol/server-filesystem",
"/Users/username/Desktop",
"/path/to/other/allowed/dir"
]
}
}
}
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.
{
"servers": {
"filesystem": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"--mount", "type=bind,src=${workspaceFolder},dst=/projects/workspace",
"mcp/filesystem",
"/projects"
]
}
}
}
NPX
{
"servers": {
"filesystem": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-filesystem",
"${workspaceFolder}"
]
}
}
}
On Windows, use:
{
"servers": {
"filesystem": {
"command": "cmd",
"args": [
"/c",
"npx",
"-y",
"@modelcontextprotocol/server-filesystem",
"${workspaceFolder}"
]
}
}
}
Build
Docker build:
docker build -t mcp/filesystem -f src/filesystem/Dockerfile .
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.
