Skip to content

Commit b7a4b16

Browse files
committed
docs(README): Add usage instructions for FastAgent integration
1 parent 9f6bf56 commit b7a4b16

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

mcp-server-filesystem/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,22 @@ Java server implementing Model Context Protocol (MCP) for filesystem operations.
1515

1616
- `file://system`: File system operations interface.
1717

18+
### Prompts
19+
20+
- **read_file**
21+
- Read complete file contents with UTF-8 encoding.
22+
- Input:
23+
* `path` (string): The filepath to read, required.
24+
- Output: "What is the complete contents of the file: /path/to/file.txt"
25+
26+
- **list_files**
27+
- List files of a directory.
28+
- Input:
29+
* `path` (string): The directory path to read, required.
30+
* `pattern` (string): Regular expression to filter files, optional, default is empty, means no filter.
31+
* `recursive` (boolean): Whether to list files recursively, optional, default is `false`.
32+
- Output: "List files in the directory: /path/to/directory, with file name pattern: *.txt, recursively: true"
33+
1834
### Tools
1935

2036
- **read_file**
@@ -68,3 +84,23 @@ mvn clean package
6884
}
6985
}
7086
```
87+
88+
## Usage with FastAgent
89+
90+
### Build
91+
92+
```bash
93+
mvn clean package
94+
```
95+
96+
### Configuration
97+
98+
Rename `fastagent-config.yaml.example` to `fastagent-config.yaml` and configure the default LLM you want to use.
99+
100+
Rename `fastagent-secrets.yaml.example` to `fastagent-secrets.yaml` and configure your LLM API key.
101+
102+
```bash
103+
pip install uv
104+
uv pip install fast-agent-mcp
105+
uv run ./agent/agent.py
106+
```

0 commit comments

Comments
 (0)