Skip to content

Commit 4b0721b

Browse files
committed
Update README.md
1 parent ffd16cf commit 4b0721b

File tree

1 file changed

+73
-42
lines changed

1 file changed

+73
-42
lines changed

README.md

Lines changed: 73 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -55,51 +55,41 @@ Token value is printed right after the executed command (it starts with
5555

5656
Choose one of these installation methods:
5757

58-
#### 2.1. Docker
58+
- [npx](#Using-npx)
59+
- [Docker](#Using-Docker)
5960

60-
For detailed information about all environment variables, see [Environment Variables](https://github.com/korotovsky/slack-mcp-server?tab=readme-ov-file#environment-variables).
61+
### 3. Configuration and Usage
6162

62-
```bash
63-
export SLACK_MCP_XOXC_TOKEN=xoxc-...
64-
export SLACK_MCP_XOXD_TOKEN=xoxd-...
63+
You can configure the MCP server using command line arguments and environment variables.
6564

66-
docker pull ghcr.io/korotovsky/slack-mcp-server:latest
67-
docker run -i --rm \
68-
-e SLACK_MCP_XOXC_TOKEN \
69-
-e SLACK_MCP_XOXD_TOKEN \
70-
slack-mcp-server --transport stdio
71-
```
65+
#### Using npx
7266

73-
#### 2.2. Docker Compose
67+
If you have npm installed, this is the fastest way to get started with `slack-mcp-server` on Claude Desktop.
7468

75-
```bash
76-
wget -O docker-compose.yml https://github.com/korotovsky/slack-mcp-server/releases/latest/download/docker-compose.yml
77-
wget -O .env https://github.com/korotovsky/slack-mcp-server/releases/latest/download/.env.dist
78-
nano .env # Edit .env file with your tokens from step 1 of the setup guide
79-
docker-compose up -d
69+
Open your `claude_desktop_config.json` and add the mcp server to the list of `mcpServers`:
70+
``` json
71+
{
72+
"mcpServers": {
73+
"slack": {
74+
"command": "npx",
75+
"args": [
76+
"-y",
77+
"slack-mcp-server@latest",
78+
"--transport",
79+
"stdio"
80+
],
81+
"env": {
82+
"SLACK_MCP_XOXC_TOKEN": "xoxc-...",
83+
"SLACK_MCP_XOXD_TOKEN": "xoxd-..."
84+
}
85+
}
86+
}
87+
}
8088
```
8189

82-
#### 2.2.1 TLS and Exposing to the Internet
83-
84-
There are several reasons why you might need to setup HTTPS for your SSE.
85-
- `mcp-remote` is capable to handle only https schemes;
86-
- it is generally a good practice to use TLS for any service exposed to the internet;
87-
88-
You could use `ngrok`:
89-
90-
```bash
91-
ngrok http 3001
92-
```
90+
<details>
91+
<summary>Or, stdio transport with docker.</summary>
9392

94-
and then use the endpoint `https://903d-xxx-xxxx-xxxx-10b4.ngrok-free.app` for your `mcp-remote` argument.
95-
96-
### 3. Configuration and Usage
97-
98-
You can configure the MCP server using command line arguments and environment variables.
99-
100-
Add the following to your `claude_desktop_config.json`:
101-
102-
#### Option 1 with `stdio` transport:
10393
```json
10494
{
10595
"mcpServers": {
@@ -127,9 +117,12 @@ Add the following to your `claude_desktop_config.json`:
127117
}
128118
```
129119

130-
#### Option 2 with `sse` transport:
120+
Please see [Docker](#Using-Docker) for more information.
121+
</details>
131122

132-
Complete steps from 2.2 and run `docker compose up -d` to launch MCP server or with your preferred method and then configure it:
123+
#### Using npx with `sse` transport:
124+
125+
In case you would like to run it in `sse` mode, then you should use `mcp-remote` wrapper for Claude Desktop and deploy/expose MCP server somewhere e.g. with `ngrok` or `docker-compose`.
133126

134127
```json
135128
{
@@ -151,9 +144,8 @@ Complete steps from 2.2 and run `docker compose up -d` to launch MCP server or w
151144
}
152145
```
153146

154-
#### Option 3 with `sse` transport on Windows:
155-
156-
Complete steps from 2.2 and run `docker compose up -d` to launch MCP server or with your preferred method and then configure it:
147+
<details>
148+
<summary>Or, sse transport for Windows.</summary>
157149

158150
```json
159151
{
@@ -174,6 +166,45 @@ Complete steps from 2.2 and run `docker compose up -d` to launch MCP server or w
174166
}
175167
}
176168
```
169+
</details>
170+
171+
#### TLS and Exposing to the Internet
172+
173+
There are several reasons why you might need to setup HTTPS for your SSE.
174+
- `mcp-remote` is capable to handle only https schemes;
175+
- it is generally a good practice to use TLS for any service exposed to the internet;
176+
177+
You could use `ngrok`:
178+
179+
```bash
180+
ngrok http 3001
181+
```
182+
183+
and then use the endpoint `https://903d-xxx-xxxx-xxxx-10b4.ngrok-free.app` for your `mcp-remote` argument.
184+
185+
#### Using Docker
186+
187+
For detailed information about all environment variables, see [Environment Variables](https://github.com/korotovsky/slack-mcp-server?tab=readme-ov-file#environment-variables).
188+
189+
```bash
190+
export SLACK_MCP_XOXC_TOKEN=xoxc-...
191+
export SLACK_MCP_XOXD_TOKEN=xoxd-...
192+
193+
docker pull ghcr.io/korotovsky/slack-mcp-server:latest
194+
docker run -i --rm \
195+
-e SLACK_MCP_XOXC_TOKEN \
196+
-e SLACK_MCP_XOXD_TOKEN \
197+
slack-mcp-server --transport stdio
198+
```
199+
200+
Or, the docker-compose way:
201+
202+
```bash
203+
wget -O docker-compose.yml https://github.com/korotovsky/slack-mcp-server/releases/latest/download/docker-compose.yml
204+
wget -O .env https://github.com/korotovsky/slack-mcp-server/releases/latest/download/.env.dist
205+
nano .env # Edit .env file with your tokens from step 1 of the setup guide
206+
docker-compose up -d
207+
```
177208

178209
#### Console Arguments
179210

0 commit comments

Comments
 (0)