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
Copy file name to clipboardExpand all lines: mcp-servers/mcp-server-filesystem-edit/README.md
+20-11Lines changed: 20 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
# Filesystem Edit MCP Server
2
2
3
-
Allows for robust editing Markdown and LaTeX files.
3
+
Allows for robust editing of Markdown, Office, and LaTeX files.
4
+
Your system and configuration will determine which are supported. By default working with Markdown (`.md`) files is always enabled
4
5
5
6
This is a [Model Context Protocol](https://github.com/modelcontextprotocol) (MCP) server project.
6
7
@@ -37,6 +38,12 @@ http://127.0.0.1:25567/sse
37
38
```
38
39
39
40
41
+
### Optional Features
42
+
- If you have pdflatex installed on your system and you would like `edit_file` to automatically compile LaTeX files for you,
43
+
can provide the argument `--enable-pdflatex` when starting the server.
44
+
- If the system is Windows, it will automatically you have Office apps installed and will use them to edit `.docx` files and also view `.xlsx` files.
45
+
46
+
40
47
### Setting Working Directory
41
48
The server uses a single working directory for security purposes. There are two ways to configure them:
42
49
@@ -51,22 +58,24 @@ The server uses a single working directory for security purposes. There are two
51
58
52
59
### `view_file(path)`
53
60
- Reads the content of the file at the given path.
54
-
55
-
### `edit_file(path, task)`
61
+
- NOTE: Currently only certain common file types are supported.
62
+
- For viewing:
63
+
- Directly can view: `.md`, `.csv`, `.tex`
64
+
- Can be viewed through an office app, only on Windows: `.docx`, `.xlsx` (first worksheet)
65
+
- These file extensions can be edited:
66
+
- Directly on the filesystem: `.md`, `.tex`
67
+
- Through an office app, only on Windows: `.docx`
68
+
- If you have `pdflatex` installed and provide the `--enable-pdflatex` argument, you can also automatically compile LaTeX files.
69
+
70
+
### `edit_file(path, task: str)`
56
71
- Edits the file at the given path with the provided content according to the task.
57
72
- Uses sampling to understand things like conversation history and attachments from the client.
58
-
- If the file extension is `.md` or `.tex`, special handling is applied.
59
73
- All other file types will return an error.
60
74
- If `enable-pdflatex` is set, it will compile the LaTeX file using pdflatex and return the output.
61
75
62
-
### `add_comments(path, comments)`
76
+
### `add_comments(path, only_analyze: bool)`
63
77
- Reads the file at the given path, adds comments to the content, and returns suggestions on what to do next.
64
-
- Special handling is applied for `.md` and `.tex` files. All other file types will return an error.
65
-
66
-
67
-
### Optional Features
68
-
- If you have pdflatex installed on your system and you would like `edit_file` to automatically compile LaTeX files for you,
69
-
can provide the argument `--enable-pdflatex` when starting the server.
78
+
- If only_analyze is set to true, it will only analyze the comments in the current file and return hints on what to do next without modifying the file.
0 commit comments