You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A powerful Model Context Protocol (MCP) server for filesystem operations that provides Claude and other MCP clients with secure access to files and directories.
@@ -19,79 +18,62 @@ A powerful Model Context Protocol (MCP) server for filesystem operations that pr
19
18
- Efficiently handles large files and directories
20
19
- Ripgrep integration for blazing fast searches
21
20
- Line-targeted operations to avoid loading entire files
22
-
-**Claude Integration**: Easily installs in Claude Desktop
21
+
-**Comprehensive Testing**: 75+ tests with behavior-driven approach
23
22
-**Cross-Platform**: Works on Windows, macOS, and Linux
Run the server with access to the current directory:
39
+
### Running the Server
52
40
53
-
```bash
54
-
mcp-filesystem run
55
-
```
56
-
57
-
Allow access to specific directories:
41
+
Run the server with access to specific directories:
58
42
59
43
```bash
60
-
mcp-filesystem run /path/to/dir1 /path/to/dir2
61
-
```
44
+
# Using uv (recommended)
45
+
uv run -m mcp_filesystem run /path/to/dir1 /path/to/dir2
62
46
63
-
Use SSE transport instead of stdio:
64
-
65
-
```bash
66
-
mcp-filesystem run --transport sse --port 8000
47
+
# Or using standard Python
48
+
python -m mcp_filesystem run /path/to/dir1 /path/to/dir2
67
49
```
68
50
69
-
##MCP Inspector Usage
51
+
#### Options
70
52
71
-
When using with MCP Inspector:
53
+
-`--transport` or `-t`: Transport protocol (stdio or sse, default: stdio)
54
+
-`--port` or `-p`: Port for SSE transport (default: 8000)
55
+
-`--debug` or `-d`: Enable debug logging
72
56
73
-
```
74
-
Command: uv
75
-
Arguments: --directory /path/to/mcp-filesystem run mcp-filesystem run
76
-
```
57
+
### Using with MCP Inspector
77
58
78
-
Note: The trailing `run` is required as it specifies the subcommand to execute.
59
+
For interactive testing and debugging with the MCP Inspector:
79
60
80
-
This server has been refactored to use the new FastMCP SDK for better alignment with current MCP best practices. It now uses a more efficient component caching system and direct decorator pattern rather than a class-based approach.
61
+
```bash
62
+
# Basic usage
63
+
npx @modelcontextprotocol/inspector uv run -m mcp_filesystem run /path/to/directory
81
64
82
-
## Claude Desktop Integration
65
+
# With SSE transport
66
+
npx @modelcontextprotocol/inspector uv run -m mcp_filesystem run /path/to/directory --transport sse --port 8080
83
67
84
-
To install in Claude Desktop:
68
+
# With debug output
69
+
npx @modelcontextprotocol/inspector uv run -m mcp_filesystem run /path/to/directory --debug
70
+
```
85
71
86
-
```bash
87
-
# Using mcp CLI
88
-
mcp install mcp-filesystem
72
+
This server has been built with the FastMCP SDK for better alignment with current MCP best practices. It uses an efficient component caching system and direct decorator pattern.
0 commit comments