Skip to content

Commit b320dbd

Browse files
actions-useractions-user
committed
docs/capabilities.md via mcp-discovery
1 parent f3ea41c commit b320dbd

File tree

1 file changed

+139
-25
lines changed

1 file changed

+139
-25
lines changed

‎docs/capabilities.md‎

Lines changed: 139 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Capabilities
22

33
<!-- mcp-discovery-render -->
4-
## rust-mcp-filesystem 0.2.3
5-
| 🟢 Tools (16) | <span style="opacity:0.6">🔴 Prompts</span> | <span style="opacity:0.6">🔴 Resources</span> | <span style="opacity:0.6">🔴 Logging</span> | <span style="opacity:0.6">🔴 Experimental</span> |
4+
## rust-mcp-filesystem 0.3.0
5+
| 🟢 Tools (24) | <span style="opacity:0.6">🔴 Prompts</span> | <span style="opacity:0.6">🔴 Resources</span> | <span style="opacity:0.6">🔴 Logging</span> | <span style="opacity:0.6">🔴 Experimental</span> |
66
| --- | --- | --- | --- | --- |
7-
## 🛠️ Tools (16)
7+
## 🛠️ Tools (24)
88

99
<table style="text-align: left;">
1010
<thead>
@@ -18,6 +18,19 @@
1818
<tbody style="vertical-align: top;">
1919
<tr>
2020
<td>1.</td>
21+
<td>
22+
<code><b>calculate_directory_size</b></code>
23+
</td>
24+
<td>Calculates the total size of a directory specified by <code>root_path</code>.It recursively searches for files and sums their sizes. The result can be returned in either a <code>human-readable</code> format or as <code>bytes</code>, depending on the specified <code>output_format</code> argument.Only works within allowed directories.</td>
25+
<td>
26+
<ul>
27+
<li> <code>output_format</code> : human-readable | bytes<br /></li>
28+
<li> <code>root_path</code> : string<br /></li>
29+
</ul>
30+
</td>
31+
</tr>
32+
<tr>
33+
<td>2.</td>
2134
<td>
2235
<code><b>create_directory</b></code>
2336
</td>
@@ -29,20 +42,20 @@
2942
</td>
3043
</tr>
3144
<tr>
32-
<td>2.</td>
45+
<td>3.</td>
3346
<td>
3447
<code><b>directory_tree</b></code>
3548
</td>
3649
<td>Get a recursive tree view of files and directories as a JSON structure. Each entry includes <code>name</code>, <code>type</code> (file/directory), and <code>children</code> for directories. Files have no children array, while directories always have a children array (which may be empty). If the <code>max_depth</code> parameter is provided, the traversal will be limited to the specified depth. As a result, the returned directory structure may be incomplete or provide a skewed representation of the full directory tree, since deeper-level files and subdirectories beyond the specified depth will be excluded. The output is formatted with 2-space indentation for readability. Only works within allowed directories.</td>
3750
<td>
3851
<ul>
39-
<li> <code>max_depth</code> : number<br /></li>
52+
<li> <code>max_depth</code> : integer<br /></li>
4053
<li> <code>path</code> : string<br /></li>
4154
</ul>
4255
</td>
4356
</tr>
4457
<tr>
45-
<td>3.</td>
58+
<td>4.</td>
4659
<td>
4760
<code><b>edit_file</b></code>
4861
</td>
@@ -56,7 +69,38 @@
5669
</td>
5770
</tr>
5871
<tr>
59-
<td>4.</td>
72+
<td>5.</td>
73+
<td>
74+
<code><b>find_duplicate_files</b></code>
75+
</td>
76+
<td>Find duplicate files within a directory and return list of duplicated files as text or json formatOptional <code>pattern</code> argument can be used to narrow down the file search to specific glob pattern.Optional <code>exclude_patterns</code> can be used to exclude certain files matching a glob.<code>min_bytes</code> and <code>max_bytes</code> are optional arguments that can be used to restrict the search to files with sizes within a specified range.The output_format argument specifies the format of the output and accepts either <code>text</code> or <code>json</code> (default: text).Only works within allowed directories.</td>
77+
<td>
78+
<ul>
79+
<li> <code>exclude_patterns</code> : string [ ]<br /></li>
80+
<li> <code>max_bytes</code> : integer<br /></li>
81+
<li> <code>min_bytes</code> : integer<br /></li>
82+
<li> <code>output_format</code> : text | json<br /></li>
83+
<li> <code>pattern</code> : string<br /></li>
84+
<li> <code>root_path</code> : string<br /></li>
85+
</ul>
86+
</td>
87+
</tr>
88+
<tr>
89+
<td>6.</td>
90+
<td>
91+
<code><b>find_empty_directories</b></code>
92+
</td>
93+
<td>Recursively finds all empty directories within the given root path.A directory is considered empty if it contains no files in itself or any of its subdirectories.Operating system metadata files `.DS_Store` (macOS) and `Thumbs.db` (Windows) will be ignored.The optional exclude_patterns argument accepts glob-style patterns to exclude specific paths from the search.Only works within allowed directories.</td>
94+
<td>
95+
<ul>
96+
<li> <code>exclude_patterns</code> : string [ ]<br /></li>
97+
<li> <code>output_format</code> : text | json<br /></li>
98+
<li> <code>path</code> : string<br /></li>
99+
</ul>
100+
</td>
101+
</tr>
102+
<tr>
103+
<td>7.</td>
60104
<td>
61105
<code><b>get_file_info</b></code>
62106
</td>
@@ -68,7 +112,33 @@
68112
</td>
69113
</tr>
70114
<tr>
71-
<td>5.</td>
115+
<td>8.</td>
116+
<td>
117+
<code><b>head_file</b></code>
118+
</td>
119+
<td>Reads and returns the first N lines of a text file.This is useful for quickly previewing file contents without loading the entire file into memory.If the file has fewer than N lines, the entire file will be returned.Only works within allowed directories.</td>
120+
<td>
121+
<ul>
122+
<li> <code>lines</code> : integer<br /></li>
123+
<li> <code>path</code> : string<br /></li>
124+
</ul>
125+
</td>
126+
</tr>
127+
<tr>
128+
<td>9.</td>
129+
<td>
130+
<code><b>head_file</b></code>
131+
</td>
132+
<td>Reads and returns the last N lines of a text file.This is useful for quickly previewing file contents without loading the entire file into memory.If the file has fewer than N lines, the entire file will be returned.Only works within allowed directories.</td>
133+
<td>
134+
<ul>
135+
<li> <code>lines</code> : integer<br /></li>
136+
<li> <code>path</code> : string<br /></li>
137+
</ul>
138+
</td>
139+
</tr>
140+
<tr>
141+
<td>10.</td>
72142
<td>
73143
<code><b>list_allowed_directories</b></code>
74144
</td>
@@ -79,7 +149,7 @@
79149
</td>
80150
</tr>
81151
<tr>
82-
<td>6.</td>
152+
<td>11.</td>
83153
<td>
84154
<code><b>list_directory</b></code>
85155
</td>
@@ -91,7 +161,7 @@
91161
</td>
92162
</tr>
93163
<tr>
94-
<td>7.</td>
164+
<td>12.</td>
95165
<td>
96166
<code><b>list_directory_with_sizes</b></code>
97167
</td>
@@ -103,7 +173,7 @@
103173
</td>
104174
</tr>
105175
<tr>
106-
<td>8.</td>
176+
<td>13.</td>
107177
<td>
108178
<code><b>move_file</b></code>
109179
</td>
@@ -116,61 +186,105 @@
116186
</td>
117187
</tr>
118188
<tr>
119-
<td>9.</td>
189+
<td>14.</td>
120190
<td>
121-
<code><b>read_file</b></code>
191+
<code><b>read_file_lines</b></code>
122192
</td>
123-
<td>Read the complete contents of a file from the file system. Handles various text encodings and provides detailed error messages if the file cannot be read. Use this tool when you need to examine the contents of a single file. Only works within allowed directories.</td>
193+
<td>Reads lines from a text file starting at a specified line offset (0-based) and continues for the specified number of lines if a limit is provided.This function skips the first <code>offset</code> lines and then reads up to <code>limit</code> lines if specified, or reads until the end of the file otherwise.It's useful for partial reads, pagination, or previewing sections of large text files.Only works within allowed directories.</td>
124194
<td>
125195
<ul>
196+
<li> <code>limit</code> : integer<br /></li>
197+
<li> <code>offset</code> : integer<br /></li>
126198
<li> <code>path</code> : string<br /></li>
127199
</ul>
128200
</td>
129201
</tr>
130202
<tr>
131-
<td>10.</td>
203+
<td>15.</td>
204+
<td>
205+
<code><b>read_media_file</b></code>
206+
</td>
207+
<td>Reads an image or audio file and returns its Base64-encoded content along with the corresponding MIME type. The max_bytes argument could be used to enforce an upper limit on the size of a file to read if the media file exceeds this limit, the operation will return an error instead of reading the media file. Access is restricted to files within allowed directories only.</td>
208+
<td>
209+
<ul>
210+
<li> <code>max_bytes</code> : integer<br /></li>
211+
<li> <code>path</code> : string<br /></li>
212+
</ul>
213+
</td>
214+
</tr>
215+
<tr>
216+
<td>16.</td>
132217
<td>
133-
<code><b>read_multiple_files</b></code>
218+
<code><b>read_multiple_media_files</b></code>
134219
</td>
135-
<td>Read the contents of multiple files simultaneously. This is more efficient than reading files one by one when you need to analyze or compare multiple files. Each file's content is returned with its path as a reference. Failed reads for individual files won't stop the entire operation. Only works within allowed directories.</td>
220+
<td>Reads multiple image or audio files and returns their Base64-encoded contents along with corresponding MIME types. This method is more efficient than reading files individually. The max_bytes argument could be used to enforce an upper limit on the size of a file to read Failed reads for specific files are skipped without interrupting the entire operation. Only works within allowed directories.</td>
136221
<td>
137222
<ul>
223+
<li> <code>max_bytes</code> : integer<br /></li>
138224
<li> <code>paths</code> : string [ ]<br /></li>
139225
</ul>
140226
</td>
141227
</tr>
142228
<tr>
143-
<td>11.</td>
229+
<td>17.</td>
230+
<td>
231+
<code><b>read_multiple_text_files</b></code>
232+
</td>
233+
<td>Read the contents of multiple text files simultaneously as text. This is more efficient than reading files one by one when you need to analyze or compare multiple files. Each file's content is returned with its path as a reference. Failed reads for individual files won't stop the entire operation. Only works within allowed directories.</td>
234+
<td>
235+
<ul>
236+
<li> <code>paths</code> : string [ ]<br /></li>
237+
</ul>
238+
</td>
239+
</tr>
240+
<tr>
241+
<td>18.</td>
242+
<td>
243+
<code><b>read_text_file</b></code>
244+
</td>
245+
<td>Read the complete contents of a text file from the file system as text. Handles various text encodings and provides detailed error messages if the file cannot be read. Use this tool when you need to examine the contents of a single file. Only works within allowed directories.</td>
246+
<td>
247+
<ul>
248+
<li> <code>path</code> : string<br /></li>
249+
</ul>
250+
</td>
251+
</tr>
252+
<tr>
253+
<td>19.</td>
144254
<td>
145255
<code><b>search_files</b></code>
146256
</td>
147-
<td>Recursively search for files and directories matching a pattern. Searches through all subdirectories from the starting path. The search is case-insensitive and matches partial names. Returns full paths to all matching items. Great for finding files when you don't know their exact location. Only searches within allowed directories.</td>
257+
<td>Recursively search for files and directories matching a pattern. Searches through all subdirectories from the starting path. The search is case-insensitive and matches partial names. Returns full paths to all matching items.Optional <code>min_bytes</code> and <code>max_bytes</code> arguments can be used to filter files by size, ensuring that only files within the specified byte range are included in the search. This tool is great for finding files when you don't know their exact location or find files by their size.Only searches within allowed directories.</td>
148258
<td>
149259
<ul>
150260
<li> <code>excludePatterns</code> : string [ ]<br /></li>
261+
<li> <code>max_bytes</code> : integer<br /></li>
262+
<li> <code>min_bytes</code> : integer<br /></li>
151263
<li> <code>path</code> : string<br /></li>
152264
<li> <code>pattern</code> : string<br /></li>
153265
</ul>
154266
</td>
155267
</tr>
156268
<tr>
157-
<td>12.</td>
269+
<td>20.</td>
158270
<td>
159271
<code><b>search_files_content</b></code>
160272
</td>
161-
<td>Searches for text or regex patterns in the content of files matching matching a GLOB pattern.Returns detailed matches with file path, line number, column number and a preview of matched text.By default, it performs a literal text search; if the <code>is_regex</code> parameter is set to true, it performs a regular expression (regex) search instead.Ideal for finding specific code, comments, or text when you don’t know their exact location.</td>
273+
<td>Searches for text or regex patterns in the content of files matching matching a GLOB pattern.Returns detailed matches with file path, line number, column number and a preview of matched text.By default, it performs a literal text search; if the <code>is_regex</code> parameter is set to true, it performs a regular expression (regex) search instead.Optional <code>min_bytes</code> and <code>max_bytes</code> arguments can be used to filter files by size, ensuring that only files within the specified byte range are included in the search. Ideal for finding specific code, comments, or text when you don’t know their exact location.</td>
162274
<td>
163275
<ul>
164276
<li> <code>excludePatterns</code> : string [ ]<br /></li>
165277
<li> <code>is_regex</code> : boolean<br /></li>
278+
<li> <code>max_bytes</code> : integer<br /></li>
279+
<li> <code>min_bytes</code> : integer<br /></li>
166280
<li> <code>path</code> : string<br /></li>
167281
<li> <code>pattern</code> : string<br /></li>
168282
<li> <code>query</code> : string<br /></li>
169283
</ul>
170284
</td>
171285
</tr>
172286
<tr>
173-
<td>13.</td>
287+
<td>21.</td>
174288
<td>
175289
<code><b>unzip_file</b></code>
176290
</td>
@@ -183,7 +297,7 @@
183297
</td>
184298
</tr>
185299
<tr>
186-
<td>14.</td>
300+
<td>22.</td>
187301
<td>
188302
<code><b>write_file</b></code>
189303
</td>
@@ -196,7 +310,7 @@
196310
</td>
197311
</tr>
198312
<tr>
199-
<td>15.</td>
313+
<td>23.</td>
200314
<td>
201315
<code><b>zip_directory</b></code>
202316
</td>
@@ -210,7 +324,7 @@
210324
</td>
211325
</tr>
212326
<tr>
213-
<td>16.</td>
327+
<td>24.</td>
214328
<td>
215329
<code><b>zip_files</b></code>
216330
</td>

0 commit comments

Comments
 (0)