Skip to content

Commit ebfd210

Browse files
committed
docs: update README
1 parent 3eee3e6 commit ebfd210

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

Diff for: src/slack/README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ MCP Server for the Slack API, enabling Claude to interact with Slack workspaces.
55
## Tools
66

77
1. `slack_list_channels`
8-
- List public channels in the workspace
8+
- List public or pre-defined channels in the workspace
99
- Optional inputs:
1010
- `limit` (number, default: 100, max: 200): Maximum number of channels to return
1111
- `cursor` (string): Pagination cursor for next page
@@ -102,7 +102,8 @@ Add the following to your `claude_desktop_config.json`:
102102
],
103103
"env": {
104104
"SLACK_BOT_TOKEN": "xoxb-your-bot-token",
105-
"SLACK_TEAM_ID": "T01234567"
105+
"SLACK_TEAM_ID": "T01234567",
106+
"SLACK_CHANNEL_IDS": "C01234567, C76543210"
106107
}
107108
}
108109
}
@@ -124,17 +125,26 @@ Add the following to your `claude_desktop_config.json`:
124125
"SLACK_BOT_TOKEN",
125126
"-e",
126127
"SLACK_TEAM_ID",
128+
"-e",
129+
"SLACK_CHANNEL_IDS",
127130
"mcp/slack"
128131
],
129132
"env": {
130133
"SLACK_BOT_TOKEN": "xoxb-your-bot-token",
131-
"SLACK_TEAM_ID": "T01234567"
134+
"SLACK_TEAM_ID": "T01234567",
135+
"SLACK_CHANNEL_IDS": "C01234567, C76543210"
132136
}
133137
}
134138
}
135139
}
136140
```
137141

142+
### Environment Variables
143+
144+
1. `SLACK_BOT_TOKEN`: Required. The Bot User OAuth Token starting with `xoxb-`.
145+
2. `SLACK_TEAM_ID`: Required. Your Slack workspace ID starting with `T`.
146+
3. `SLACK_CHANNEL_IDS`: Optional. Comma-separated list of channel IDs to limit channel access (e.g., "C01234567, C76543210"). If not set, all public channels will be listed.
147+
138148
### Troubleshooting
139149

140150
If you encounter permission errors, verify that:

0 commit comments

Comments
 (0)