|
| 1 | +# Filesystem MCP Server |
| 2 | + |
| 3 | +Go server implementing Model Context Protocol (MCP) for filesystem operations. |
| 4 | + |
| 5 | +## Features |
| 6 | + |
| 7 | +- Read/write files |
| 8 | +- Create/list/delete directories |
| 9 | +- Move files/directories |
| 10 | +- Search files |
| 11 | +- Get file metadata |
| 12 | + |
| 13 | +**Note**: The server will only allow operations within directories specified via `args`. |
| 14 | + |
| 15 | +## API |
| 16 | + |
| 17 | +### Resources |
| 18 | + |
| 19 | +- `file://system`: File system operations interface |
| 20 | + |
| 21 | +### Tools |
| 22 | + |
| 23 | +- **read_file** |
| 24 | + - Read complete contents of a file |
| 25 | + - Input: `path` (string) |
| 26 | + - Reads complete file contents with UTF-8 encoding |
| 27 | + |
| 28 | +- **read_multiple_files** |
| 29 | + - Read multiple files simultaneously |
| 30 | + - Input: `paths` (string[]) |
| 31 | + - Failed reads won't stop the entire operation |
| 32 | + |
| 33 | +- **write_file** |
| 34 | + - Create new file or overwrite existing (exercise caution with this) |
| 35 | + - Inputs: |
| 36 | + - `path` (string): File location |
| 37 | + - `content` (string): File content |
| 38 | + |
| 39 | +- **create_directory** |
| 40 | + - Create new directory or ensure it exists |
| 41 | + - Input: `path` (string) |
| 42 | + - Creates parent directories if needed |
| 43 | + - Succeeds silently if directory exists |
| 44 | + |
| 45 | +- **list_directory** |
| 46 | + - List directory contents with [FILE] or [DIR] prefixes |
| 47 | + - Input: `path` (string) |
| 48 | + |
| 49 | +- **move_file** |
| 50 | + - Move or rename files and directories |
| 51 | + - Inputs: |
| 52 | + - `source` (string) |
| 53 | + - `destination` (string) |
| 54 | + - Fails if destination exists |
| 55 | + |
| 56 | +- **search_files** |
| 57 | + - Recursively search for files/directories |
| 58 | + - Inputs: |
| 59 | + - `path` (string): Starting directory |
| 60 | + - `pattern` (string): Search pattern |
| 61 | + - Case-insensitive matching |
| 62 | + - Returns full paths to matches |
| 63 | + |
| 64 | +- **get_file_info** |
| 65 | + - Get detailed file/directory metadata |
| 66 | + - Input: `path` (string) |
| 67 | + - Returns: |
| 68 | + - Size |
| 69 | + - Creation time |
| 70 | + - Modified time |
| 71 | + - Access time |
| 72 | + - Type (file/directory) |
| 73 | + - Permissions |
| 74 | + |
| 75 | +- **list_allowed_directories** |
| 76 | + - List all directories the server is allowed to access |
| 77 | + - No input required |
| 78 | + - Returns: |
| 79 | + - Directories that this server can read/write from |
| 80 | + |
| 81 | +## Usage with Claude Desktop |
| 82 | +Install the server |
| 83 | +```bash |
| 84 | +go install github.com/mark3labs/mcp-filesystem-server |
| 85 | +``` |
| 86 | + |
| 87 | +Add this to your `claude_desktop_config.json`: |
| 88 | +```json |
| 89 | +{ |
| 90 | + "mcpServers": { |
| 91 | + "filesystem": { |
| 92 | + "command": "mcp-filesystem-server", |
| 93 | + "args": [ |
| 94 | + "/Users/username/Desktop", |
| 95 | + "/path/to/other/allowed/dir" |
| 96 | + ] |
| 97 | + } |
| 98 | + } |
| 99 | +} |
| 100 | +``` |
| 101 | + |
| 102 | +## License |
| 103 | + |
| 104 | +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. |
0 commit comments