Skip to content

Commit c0d1381

Browse files
committed
Support mesh collections
1 parent 2f05cf9 commit c0d1381

6 files changed

Lines changed: 1793 additions & 917 deletions

File tree

local-fs/README.md

Lines changed: 56 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# @decocms/mcp-local-fs
22

3-
Mount any local filesystem path as an MCP server. Supports both **stdio** (default) and **HTTP** transports.
3+
Mount any local filesystem path as an MCP server. **Drop-in replacement** for the official MCP filesystem server, with additional MCP Mesh collection bindings.
44

55
## Features
66

77
- 📁 Mount any filesystem path dynamically
88
- 🔌 **Stdio transport** (default) - works with Claude Desktop, Cursor, and other MCP clients
99
- 🌐 **HTTP transport** - for MCP Mesh integration
10-
- 🛠️ Full file operations: read, write, delete, move, copy, mkdir
11-
- 📋 Collection bindings for Files and Folders
10+
- 🛠️ **Full MCP filesystem compatibility** - same tools as the official server
11+
- 📋 **Collection bindings** for Files and Folders (Mesh-compatible)
12+
- 🔄 **Backward compatible** - supports both official and Mesh tool names
1213
- ⚡ Zero config needed
1314

1415
## Quick Start
@@ -84,18 +85,57 @@ Or use the path in URL format:
8485

8586
## Available Tools
8687

88+
### Official MCP Filesystem Tools
89+
90+
These tools follow the exact same schema as the [official MCP filesystem server](https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem):
91+
92+
| Tool | Description |
93+
|------|-------------|
94+
| `read_file` | Read a file (deprecated, use `read_text_file`) |
95+
| `read_text_file` | Read a text file with optional head/tail params |
96+
| `read_media_file` | Read binary/media files as base64 |
97+
| `read_multiple_files` | Read multiple files at once |
98+
| `write_file` | Write content to a file |
99+
| `edit_file` | Search/replace edits with diff preview |
100+
| `create_directory` | Create a directory (with nested support) |
101+
| `list_directory` | List files and directories |
102+
| `list_directory_with_sizes` | List with file sizes |
103+
| `directory_tree` | Recursive tree view as JSON |
104+
| `move_file` | Move or rename files/directories |
105+
| `search_files` | Search files by glob pattern |
106+
| `get_file_info` | Get detailed file/directory metadata |
107+
| `list_allowed_directories` | Show allowed directories |
108+
109+
### Additional Tools
110+
111+
| Tool | Description |
112+
|------|-------------|
113+
| `delete_file` | Delete a file or directory (with recursive option) |
114+
| `copy_file` | Copy a file to a new location |
115+
116+
### MCP Mesh Collection Bindings
117+
118+
These tools provide standard collection bindings for MCP Mesh compatibility:
119+
87120
| Tool | Description |
88121
|------|-------------|
89-
| `FILE_READ` | Read file content (utf-8 or base64) |
90-
| `FILE_WRITE` | Write content to a file |
91-
| `FILE_DELETE` | Delete a file or directory |
92-
| `FILE_MOVE` | Move or rename a file/directory |
93-
| `FILE_COPY` | Copy a file |
94-
| `FILE_MKDIR` | Create a directory |
95-
| `COLLECTION_FILES_LIST` | List files (with optional recursion) |
96-
| `COLLECTION_FILES_GET` | Get file metadata |
97-
| `COLLECTION_FOLDERS_LIST` | List folders |
98-
| `COLLECTION_FOLDERS_GET` | Get folder metadata |
122+
| `COLLECTION_FILES_LIST` | List files with pagination |
123+
| `COLLECTION_FILES_GET` | Get file metadata and content by path |
124+
| `COLLECTION_FOLDERS_LIST` | List folders with pagination |
125+
| `COLLECTION_FOLDERS_GET` | Get folder metadata by path |
126+
127+
### MCP Mesh Compatibility Aliases
128+
129+
For backward compatibility with existing Mesh connections, these aliases are also available:
130+
131+
| Mesh Tool | Maps To |
132+
|-----------|---------|
133+
| `FILE_READ` | `read_text_file` |
134+
| `FILE_WRITE` | `write_file` |
135+
| `FILE_DELETE` | `delete_file` |
136+
| `FILE_MOVE` | `move_file` |
137+
| `FILE_COPY` | `copy_file` |
138+
| `FILE_MKDIR` | `create_directory` |
99139

100140
## Environment Variables
101141

@@ -116,6 +156,9 @@ npm run dev:stdio
116156
# Run in http mode (development)
117157
npm run dev
118158

159+
# Run tests
160+
npm test
161+
119162
# Type check
120163
npm run check
121164

0 commit comments

Comments
 (0)