Skip to content

Commit dbcae94

Browse files
committed
add instructions for each OS
1 parent 83b9464 commit dbcae94

File tree

1 file changed

+42
-8
lines changed

1 file changed

+42
-8
lines changed

README.md

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,57 @@ Note: At the moment this only works with MCP servers that use the `2024-11-05` s
66

77
## Installation
88

9-
First, find the correct archive from [the release page](https://github.com/tidewave-ai/mcp_proxy_rust/releases).
10-
Note that these binaries are not notarized. On macOS, you won't be able to run them if you download them through
11-
a web browser. You can circumvent the quarantine by directly downloading the file using curl, for example:
9+
The latest releases are available on the [releases page](https://github.com/tidewave-ai/mcp_proxy_rust/releases).
10+
11+
### macOS
12+
13+
Depending on your Mac, you can download the latest version with one of the following commands:
14+
15+
Apple Silicon:
16+
17+
```bash
18+
$ curl -sL https://github.com/tidewave-ai/mcp_proxy_rust/releases/latest/download/mcp-proxy-aarch64-apple-darwin.tar.gz | tar xv
19+
```
20+
21+
Intel:
1222

1323
```bash
14-
$ curl -sL https://github.com/tidewave-ai/mcp_proxy_rust/releases/download/v0.1.1/mcp-proxy-x86_64-apple-darwin.tar.gz | tar xv
24+
$ curl -sL https://github.com/tidewave-ai/mcp_proxy_rust/releases/latest/download/mcp-proxy-x86_64-apple-darwin.tar.gz | tar xv
1525
```
1626

17-
Alternatively, remove the quarantine flag:
27+
which will put the `mcp-proxy` binary in the current working directory (`pwd`).
28+
29+
Note that the binaries are not notarized, so if you download the release with the browser, you won't be able to open it.
30+
31+
Alternatively, you can remove the quarantine flag with:
1832

1933
```bash
2034
$ xattr -d com.apple.quarantine /path/to/mcp-proxy
2135
```
2236

23-
After downloading and extracting the release, the proxy is ready to be used.
37+
### Linux
38+
39+
You can download the latest release from the [Releases page](https://github.com/tidewave-ai/mcp_proxy_rust/releases) or with one command, depending on your architecture:
40+
41+
x86:
42+
43+
```bash
44+
$ curl -sL https://github.com/tidewave-ai/mcp_proxy_rust/releases/latest/download/mcp-proxy-x86_64-unknown-linux-musl.tar.gz | tar xv
45+
```
46+
47+
arm64 / aarch64:
48+
49+
```bash
50+
$ curl -sL https://github.com/tidewave-ai/mcp_proxy_rust/releases/latest/download/mcp-proxy-aarch64-unknown-linux-musl.tar.gz | tar xv
51+
```
52+
53+
### Windows
54+
55+
You can download the latest release from the [Releases page](https://github.com/tidewave-ai/mcp_proxy_rust/releases) or with the following Powershell command:
56+
57+
```powershell
58+
curl.exe -L -o mcp-proxy.zip https://github.com/tidewave-ai/mcp_proxy_rust/releases/latest/download/mcp-proxy-x86_64-pc-windows-msvc.zip; Expand-Archive -Path mcp-proxy.zip -DestinationPath .
59+
```
2460

2561
## Building from scratch
2662

@@ -38,8 +74,6 @@ If you have an SSE MCP server available at `http://localhost:4000/tidewave/mcp`,
3874

3975
### On macos/Linux
4076

41-
You will also need to know the location of the `escript` executable, so run `which escript` before to get the value of "path/to/escript":
42-
4377
```json
4478
{
4579
"mcpServers": {

0 commit comments

Comments
 (0)