易松弛mcp
🚀 The Easiest way to run Slack MCP
人工智能助手的Slack集成 -将Cursor、Claude Desktop和其他MCP兼容工具直接连接到Slack。使用AI发送消息、阅读频道、管理用户和自动化工作流程。
📦 我们提供什么
| 特性 | 描述 |
|---|---|
| MCP服务器 | AI助手(Cursor、Claude Desktop等)的完整模型上下文协议集成 |
| REST API | 使用OpenAPI/Swagger文档完成Slack API包装 |
| 消息管理 | 在频道和DM中发送、更新和删除消息 |
| 渠道运作 | 列出、创建、查看频道的详细信息和读取频道的消息历史记录 |
| 用户管理 | 列出用户、获取用户信息和访问用户配置文件 |
| 文件操作 | 上传文件、列出文件和获取文件信息 |
| 反应 | 添加和删除对消息的表情符号反应 |
| 交互式文档 | Swagger UI用于探索和测试所有端点 |
| 零配置 | 只需一个命令即可运行-只需提供您的Slack机器人令牌 |
| 生产就绪 | 基于 简易mcp服务器 框架 |
🚀 快速开始```bash
SLACK_BOT_TOKEN=xoxb-your-token-here npx easy-slack-mcp
**就是这样!** 服务器运行在:
|服务|URL|备注|
|---|---|---|
|REST API| `http://localhost:8887` |所有端点的基础|
|API文档(Swagger UI)| `http://localhost:8887/docs` |交互式文档|
|MCP服务器| `http://localhost:8888` |适用于MCP兼容客户端|
______________________________________________________________________
## 📋 详细配置
### 获取您的Slack Bot令牌
1. 首选 https://api.slack.com/apps
1. 点击 **“创建新应用程序”** → **“从头开始”**
1. 为您的应用命名并选择工作区
1. 点击 **“创建应用程序”**
1. 导航至 **“OAuth和权限”** 在侧边栏中
1. 向下滚动至 **“机器人令牌范围”** 并添加以下范围:
- `chat:write` -发送消息
- `chat:write.public` -发送到频道机器人不在
- `channels:read` -查看频道信息
- `channels:history` -读取频道消息
- `users:read` -查看用户
- `users:read.email` -查看电子邮件地址
- `files:write` -上传文件
- `files:read` -查看文件
- `reactions:write` -添加反应
- `reactions:read` -查看反应
1. 滚动到顶部并单击 **“安装到工作区”**
1. 授权应用程序
1. 复制您的 **Bot用户OAuth令牌** (开始于 `xoxb-`)
### 使用环境变量
您可以使用 `.env` 持久配置文件:```bash
# Create .env file
echo "SLACK_BOT_TOKEN=xoxb-your-token-here" > .env
# Run (it will automatically load .env)
npx easy-slack-mcp
本地安装
对于永久性本地安装:```bash
Install locally
npm install easy-slack-mcp
Create .env file
echo "SLACK_BOT_TOKEN=xoxb-your-token-here" > .env
Run
npm start
OR
npx easy-slack-mcp
______________________________________________________________________
## 💻 在Cursor/Claude桌面中使用
### 选项A:用作npm包(推荐)
**对于光标:**
1. 打开光标设置→ 特性→ 模型上下文协议
1. 点击“编辑配置”
1. 将此添加到您的MCP配置中:```json
{
"mcpServers": {
"easy-slack-mcp": {
"command": "npx",
"args": ["-y", "easy-slack-mcp"],
"env": {
"SLACK_BOT_TOKEN": "xoxb-your-token-here"
}
}
}
}
对于Claude Desktop:
- 打开
~/Library/Application Support/Claude/claude_desktop_config.json(Mac)
或%APPDATA%\Claude\claude_desktop_config.json(Windows) - 添加上面相同的配置
对于任何MCP客户端:
通过调用时,服务器会自动运行 npx easy-slack-mcp
客户端配置路径
| 客户端 | 平台 | 配置位置 |
|---|---|---|
| 光标 | macOS/Windows/Linux | 设置→ 特性→ 模型上下文协议 |
| 克劳德桌面 | macOS | ~/Library/Application Support/Claude/claude_desktop_config.json |
| 克劳德桌面 | Windows | %APPDATA%\Claude\claude_desktop_config.json |
选项B:本地安装
如果您更喜欢本地设置:```bash
Install locally
npm install easy-slack-mcp
Create .env file
echo "SLACK_BOT_TOKEN=xoxb-your-token-here" > .env
Run it
npx easy-slack-mcp
然后配置您的MCP客户端以运行:```bash
npx easy-slack-mcp
📡 使用REST API
服务器运行后,您可以通过REST端点完全访问Slack。
🔍 交互式API文档
| 名称 | URL | 最适合 |
|---|---|---|
| Swagger用户界面 | http://localhost:8887/docs |
浏览端点、尝试请求、查看架构 |
| OpenAPI JSON | http://localhost:8887/openapi.json |
导入邮差/失眠或工具 |
📝 常见API示例
发送信息```bash
curl -X POST http://localhost:8887/slack/messages \
-H "Content-Type: application/json" \
-d '{
"channel": "C1234567890",
"text": "Hello from easy-slack-mcp!"
}'
#### 列出频道```bash
curl "http://localhost:8887/slack/conversations/list?types=public_channel"
获取频道历史记录```bash
curl "http://localhost:8887/slack/conversations/history?channel=C1234567890&limit=20"
#### 列出用户```bash
curl "http://localhost:8887/slack/users/list"
上传文件```bash
curl -X POST http://localhost:8887/slack/files/upload \
-H "Content-Type: application/json" \
-d '{
"channels": "C1234567890",
"filename": "report.txt",
"content": "File content here"
}'
______________________________________________________________________
## 📚 所有可用端点
|类别|方法|路径|描述|
|---|---|---|---|
|消息| POST| `/slack/messages` |发送消息|
|消息| POST| `/slack/messages/update` |更新消息|
|消息| POST| `/slack/messages/delete` |删除消息|
|对话|获取| `/slack/conversations/list` |列出所有频道|
|对话|获取| `/slack/conversations/info` |获取频道详细信息|
|对话| POST| `/slack/conversations/create` |创建频道|
|对话|获取| `/slack/conversations/history` |获取消息历史记录|
|用户| GET| `/slack/users/list` |列出工作区用户|
|用户| GET| `/slack/users/info` |获取用户详细信息|
|用户| GET| `/slack/users/profile` |获取用户资料|
|文件| POST| `/slack/files/upload` |上传文件|
|文件| GET| `/slack/files/list` |列出文件|
|文件| GET| `/slack/files/info` |获取文件信息|
|反应| POST| `/slack/reactions/add` |添加反应|
|反应| POST| `/slack/reactions/remove` |消除反应|
|身份验证| GET| `/slack/auth/test` |测试身份验证|
|系统| GET| `/health` |健康检查|
|系统| GET| `/api-info` |API信息|
|系统| GET| `/openapi.json` |OpenAPI规范|
|系统| GET| `/docs` |Swagger用户界面文档|
______________________________________________________________________
## ⚙️ 高级配置
### 环境变量
所有配置都可以通过环境变量进行设置:
|名称|必填|默认|描述|
|---|---|---|---|
| `SLACK_BOT_TOKEN` |是|--| Bot用户OAuth令牌(以开头 `xoxb-`) |
| `SLACK_APP_TOKEN` |Socket模式没有|--|应用程序级令牌(以开头 `xapp-`) |
| `SLACK_SIGNING_SECRET` |否|-|验证事件/API网关的Slack请求签名|
| `EASY_MCP_SERVER_PORT` |没有| `8887` |REST API端口|
| `EASY_MCP_SERVER_MCP_PORT` |没有| `8888` |MCP服务器端口|
示例 `.env` 内容:```bash
SLACK_BOT_TOKEN=xoxb-your-token-here
# Optional
SLACK_APP_TOKEN=xapp-your-app-token
SLACK_SIGNING_SECRET=your-signing-secret
EASY_MCP_SERVER_PORT=8887
EASY_MCP_SERVER_MCP_PORT=8888
所需松弛范围
看 详细配置 以上部分介绍了设置步骤。机器人通常需要这些作用域:
| 范围 | 目的 |
|---|---|
chat:write |
以机器人身份发送消息 |
chat:write.public |
发布到机器人不是的频道 |
channels:read |
查看基本频道信息 |
channels:history |
读取频道消息 |
users:read |
查看工作区中的用户 |
users:read.email |
查看用户电子邮件地址 |
files:write |
上传文件 |
files:read |
查看文件 |
reactions:write |
向消息添加反应 |
reactions:read |
查看对消息的反应 |
🎯 用例
在Cursor/Claude桌面中
- “向#general发送一条关于项目更新的消息”
- “#support channel的最新活动是什么?”
- “查找用户@john并显示其个人资料”
- “在#engineering中总结本周的信息”
通过REST API
- 构建自定义集成
- 自动化Slack工作流程
- 创建Slack机器人
- 与其他服务集成
通过Swagger用户界面
- 直观地探索端点
- 测试API调用
- 了解请求/响应格式
- 共享API文档
📖 了解更多
- 简易MCP服务器框架:
- GitHub存储库
- npm包
- 完整设置指南:参见 mcp/resources/slack-quick-start.md
- 完成API文档:参见 mcp/资源/api-documentation.md
- 松弛API: https://api.slack.com/methods
- 模型上下文协议: https://modelcontextprotocol.io/
📦 包信息
| 项目 | 链接/值 |
|---|---|
| npm | 易松弛mcp |
| 存储库 | GitHub |
| 许可证 | 麻省理工学院 |
🆘 需要帮助?
- 检查 Swagger用户界面: http://localhost:8887/docs
- 测试身份验证:
curl http://localhost:8887/slack/auth/test - 检查服务器运行状况:
curl http://localhost:8887/health - 查看 安装指南
- 如需定制或支持,请联系
info@easynet.world
准备好用AI自动化Slack了吗? 开始:```bash
Install and run directly
npx easy-slack-mcp
Or install locally for project use
npm install easy-slack-mcp
npm start
```
由...驱动 简易mcp服务器 框架
