Skip to content

Commit 5f7680e

Browse files
committed
update docs
1 parent 2d9e7a0 commit 5f7680e

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/guide/cli-command-options.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
## CLI Command Options
22

33
```sh
4-
Usage: rust-mcp-filesystem [OPTIONS] <ALLOWED_DIRECTORIES>...
4+
Usage: rust-mcp-filesystem [OPTIONS] [ALLOWED_DIRECTORIES]...
55

66
Arguments:
7-
<ALLOWED_DIRECTORIES>...
7+
[ALLOWED_DIRECTORIES]...
88
Provide a space-separated list of directories that are permitted for the operation.
99
This list allows multiple directories to be provided.
1010

1111
Example: rust-mcp-filesystem /path/to/dir1 /path/to/dir2 /path/to/dir3
1212

1313
Options:
1414
-w, --allow-write
15-
Enables read/write mode for the app, allowing both reading and writing.
15+
Enables read/write mode for the app, allowing both reading and writing. Defaults to disabled.
16+
17+
-t, --enable-roots
18+
Enables dynamic directory access control via Roots from the MCP client side. Defaults to disabled.
19+
When enabled, MCP clients that support Roots can dynamically update the allowed directories.
20+
Any directories provided by the client will completely replace the initially configured allowed directories on the server.
1621

1722
-h, --help
1823
Print help (see a summary with '-h')

0 commit comments

Comments
 (0)