Skip to content

Commit 10949df

Browse files
committed
docs: updated documentation with installation and dockerhub registry
1 parent b3c000a commit 10949df

File tree

3 files changed

+39
-4
lines changed

3 files changed

+39
-4
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
Rust MCP Filesystem is a blazingly fast, asynchronous, and lightweight MCP (Model Context Protocol) server designed for efficient handling of various filesystem operations.
88
This project is a pure Rust rewrite of the JavaScript-based `@modelcontextprotocol/server-filesystem`, offering enhanced capabilities, improved performance, and a robust feature set tailored for modern filesystem interactions.
99

10-
🚀 Refer to the [project documentation](https://rust-mcp-stack.github.io/rust-mcp-filesystem) for installation and configuration instructions.
10+
📝 Refer to the [project documentation](https://rust-mcp-stack.github.io/rust-mcp-filesystem) for installation and configuration instructions.
11+
12+
⭐️ It is also available on [Docker Hub’s MCP Registry](https://hub.docker.com/mcp/server/rust-mcp-filesystem) at: https://hub.docker.com/mcp/server/rust-mcp-filesystem
1113

1214
## Features
1315

@@ -24,6 +26,36 @@ This project is a pure Rust rewrite of the JavaScript-based `@modelcontextprotoc
2426

2527
For detailed setup instructions, please visit the [project documentation](https://rust-mcp-stack.github.io/rust-mcp-filesystem).
2628

29+
30+
### Quick installation guide
31+
32+
33+
<!-- x-release-please-start-version -->
34+
- **Shell script**
35+
```sh
36+
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/rust-mcp-stack/rust-mcp-filesystem/releases/download/v0.3.3/rust-mcp-filesystem-installer.sh | sh
37+
```
38+
39+
- **PowerShell script**
40+
```sh
41+
powershell -ExecutionPolicy Bypass -c "irm https://github.com/rust-mcp-stack/rust-mcp-filesystem/releases/download/v0.3.3/rust-mcp-filesystem-installer.ps1 | iex"
42+
```
43+
44+
- **Homebrew**
45+
```sh
46+
brew install rust-mcp-stack/tap/rust-mcp-filesystem
47+
```
48+
- **Docker**
49+
50+
https://hub.docker.com/mcp/server/rust-mcp-filesystem
51+
52+
- **Download Binaries**
53+
54+
https://github.com/rust-mcp-stack/rust-mcp-filesystem/releases/tag/v0.3.3
55+
56+
<!-- x-release-please-end -->
57+
58+
2759
## Purpose
2860

2961
This project aims to provide a reliable, secure, and feature-rich MCP server for filesystem management, reimagining the capabilities of @modelcontextprotocol/server-filesystem in a more performant and type-safe language. Whether you’re building tools for file exploration, automation, or system integration, rust-mcp-filesystem offers a solid foundation.

docs/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
Rust MCP Filesystem is a blazingly fast, asynchronous, and lightweight MCP (Model Context Protocol) server designed for efficient handling of various filesystem operations.
44
This project is a pure Rust rewrite of the JavaScript-based **@modelcontextprotocol/server-filesystem**, offering enhanced capabilities, improved performance, and a robust feature set tailored for modern filesystem interactions.
55

6-
Refer to the [quickstart](quickstart.md) guide for installation and configuration instructions.
7-
86
## Features
97

108
- **⚡ High Performance**: Built in Rust for speed and efficiency, leveraging asynchronous I/O to handle filesystem operations seamlessly.
@@ -16,6 +14,11 @@ Refer to the [quickstart](quickstart.md) guide for installation and configuratio
1614

1715
#### Refer to &nbsp; [capabilities](capabilities.md) &nbsp; for a full list of tools and other capabilities.
1816

17+
18+
## Installation
19+
Refer to the [quickstart](quickstart.md) guide for installation and configuration instructions.
20+
21+
1922
## Purpose
2023

2124
This project aims to provide a reliable, secure, and feature-rich MCP server for filesystem management, reimagining the capabilities of **@modelcontextprotocol/server-filesystem** in a more performant and type-safe language. Whether you’re using this for file exploration, automation, or system integration, rust-mcp-filesystem offers a solid foundation.

docs/_configs/claude-desktop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Incorporate the following into your `claude_desktop_config.json`, based on your
5656
"type=bind,src=/Users/username/Documents,dst=/projects/Documents",
5757
"--mount",
5858
"type=bind,src=/other/allowed/dir,dst=/projects/other/allowed/dir",
59-
"rustmcp/filesystem",
59+
"mcp/rust-mcp-filesystem",
6060
"/projects"
6161
]
6262
}

0 commit comments

Comments
 (0)