README.md
Filesystem MCP Server
Node.js server 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 locationcontent
(string): File content
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 directorypattern
(string): Search pattern
- 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
Usage with Claude Desktop
Add this to your claude_desktop_config.json
:
{
"mcpServers": {
"filesystem": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-filesystem",
"/Users/username/Desktop",
"/path/to/other/allowed/dir"
]
}
}
}
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.
Filesystem
Node.js server implementing Model Context Protocol (MCP) for filesystem operations.
Package Information
3851 stars
Updated 12/4/2024
Created 11/19/2024
MIT License
Organization
modelcontextprotocolContributors
jspahrsummers dsp-ant maheshmurag jackadamson ItsBarryZ GarvanD Skirano maledorak mikegehard elie executeautomation sergehuber anjor SkywaveTM Taylor4484 mishushakov ferrants Karthik-clearpoint kacperlukawski tb-peregrine p13rr0m fatwang2 zckly polRk varunneal sean-lynch salihergut rorylogue rishikavikondala ProRedCat