You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+73-42Lines changed: 73 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,51 +55,41 @@ Token value is printed right after the executed command (it starts with
55
55
56
56
Choose one of these installation methods:
57
57
58
-
#### 2.1. Docker
58
+
-[npx](#Using-npx)
59
+
-[Docker](#Using-Docker)
59
60
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
61
62
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.
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
+
}
80
88
```
81
89
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>
93
92
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:
103
93
```json
104
94
{
105
95
"mcpServers": {
@@ -127,9 +117,12 @@ Add the following to your `claude_desktop_config.json`:
127
117
}
128
118
```
129
119
130
-
#### Option 2 with `sse` transport:
120
+
Please see [Docker](#Using-Docker) for more information.
121
+
</details>
131
122
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`.
133
126
134
127
```json
135
128
{
@@ -151,9 +144,8 @@ Complete steps from 2.2 and run `docker compose up -d` to launch MCP server or w
151
144
}
152
145
```
153
146
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>
157
149
158
150
```json
159
151
{
@@ -174,6 +166,45 @@ Complete steps from 2.2 and run `docker compose up -d` to launch MCP server or w
174
166
}
175
167
}
176
168
```
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).
0 commit comments