Skip to content

Commit c5a364e

Browse files
docs: update README with excludePatterns documentation for search_files
1 parent 4afa873 commit c5a364e

File tree

1 file changed

+0
-112
lines changed

1 file changed

+0
-112
lines changed

src/filesystem/README.md

Lines changed: 0 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -1,110 +1,3 @@
1-
# Filesystem MCP Server
2-
3-
Node.js 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-
- **edit_file**
40-
- Make selective edits using advanced pattern matching and formatting
41-
- Features:
42-
- Line-based and multi-line content matching
43-
- Whitespace normalization with indentation preservation
44-
- Fuzzy matching with confidence scoring
45-
- Multiple simultaneous edits with correct positioning
46-
- Indentation style detection and preservation
47-
- Git-style diff output with context
48-
- Preview changes with dry run mode
49-
- Failed match debugging with confidence scores
50-
- Inputs:
51-
- `path` (string): File to edit
52-
- `edits` (array): List of edit operations
53-
- `oldText` (string): Text to search for (can be substring)
54-
- `newText` (string): Text to replace with
55-
- `dryRun` (boolean): Preview changes without applying (default: false)
56-
- `options` (object): Optional formatting settings
57-
- `preserveIndentation` (boolean): Keep existing indentation (default: true)
58-
- `normalizeWhitespace` (boolean): Normalize spaces while preserving structure (default: true)
59-
- `partialMatch` (boolean): Enable fuzzy matching (default: true)
60-
- Returns detailed diff and match information for dry runs, otherwise applies changes
61-
- Best Practice: Always use dryRun first to preview changes before applying them
62-
63-
- **create_directory**
64-
- Create new directory or ensure it exists
65-
- Input: `path` (string)
66-
- Creates parent directories if needed
67-
- Succeeds silently if directory exists
68-
69-
- **list_directory**
70-
- List directory contents with [FILE] or [DIR] prefixes
71-
- Input: `path` (string)
72-
73-
- **move_file**
74-
- Move or rename files and directories
75-
- Inputs:
76-
- `source` (string)
77-
- `destination` (string)
78-
- Fails if destination exists
79-
80-
- **search_files**
81-
- Recursively search for files/directories
82-
- Inputs:
83-
- `path` (string): Starting directory
84-
- `pattern` (string): Search pattern
85-
- Case-insensitive matching
86-
- Returns full paths to matches
87-
88-
- **get_file_info**
89-
- Get detailed file/directory metadata
90-
- Input: `path` (string)
91-
- Returns:
92-
- Size
93-
- Creation time
94-
- Modified time
95-
- Access time
96-
- Type (file/directory)
97-
- Permissions
98-
99-
- **list_allowed_directories**
100-
- List all directories the server is allowed to access
101-
- No input required
102-
- Returns:
103-
- Directories that this server can read/write from
104-
105-
## Usage with Claude Desktop
106-
Add this to your `claude_desktop_config.json`:
107-
```json
1081
{
1092
"mcpServers": {
1103
"filesystem": {
@@ -118,8 +11,3 @@ Add this to your `claude_desktop_config.json`:
11811
}
11912
}
12013
}
121-
```
122-
123-
## License
124-
125-
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

Comments
 (0)