Skip to content

Commit 8fa1d08

Browse files
committed
add docs
1 parent 0756498 commit 8fa1d08

File tree

3 files changed

+33
-3
lines changed

3 files changed

+33
-3
lines changed

.goreleaser.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ before:
66
- go generate ./...
77

88
builds:
9-
- env:
9+
- id: snmcp
10+
env:
1011
- CGO_ENABLED=0
1112
ldflags:
1213
- -s -w -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.Date}}
@@ -18,9 +19,11 @@ builds:
1819
- amd64
1920
- arm64
2021
main: ./cmd/streamnative-mcp-server
22+
binary: snmcp
2123

2224
archives:
23-
- formats: tar.gz
25+
- id: snmcp
26+
formats: tar.gz
2427
# this name template makes the OS and Arch compatible with the results of `uname`.
2528
name_template: >-
2629
{{ .ProjectName }}_

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
FROM alpine:3.21
22
RUN apk --no-cache add ca-certificates
33
WORKDIR /server
4-
COPY streamnative-mcp-server /server/snmcp
4+
COPY snmcp /server/snmcp
55

66
ENTRYPOINT ["/server/snmcp"]

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,33 @@ StreamNative MCP Server provides a standard interface for LLMs (Large Language M
3030
3131
## Installation
3232

33+
### Homebrew (macOS and Linux)
34+
35+
The easiest way to install streamnative-mcp-server is using Homebrew:
36+
37+
```bash
38+
# Add the tap repository
39+
brew tap streamnative/streamnative
40+
41+
# Install streamnative-mcp-server
42+
brew install streamnative/streamnative/snmcp
43+
```
44+
45+
### Docker Image
46+
47+
StreamNative MCP Server releases the Docker Image to [streamnative/snmcp](https://hub.docker.com/r/streamnative/snmcp), and it can be used to run both stdio server and sse server via docker command.
48+
49+
```bash
50+
# Pull image from Docker Hub
51+
docker pull streamnative/snmcp
52+
```
53+
54+
### From Github Release
55+
56+
Visit https://github.com/streamnative/streamnative-mcp-server/releases to get the latest binary of StreamNative MCP Server.
57+
58+
### From Source
59+
3360
```bash
3461
# Clone the repository
3562
git clone https://github.com/streamnative/streamnative-mcp-server.git

0 commit comments

Comments
 (0)