article
README
🚀 MCP 服务器用于 Slack
一个用于将 AI 助手集成到 Slack 工作区的 Model Context Protocol (MCP) 服务器实现,借助该服务器,AI 助手可与 Slack 工作区进行交互,实现多种功能。
🚀 快速开始
此包提供了一个 MCP 服务器,使 AI 助手能够与 Slack 工作区交互。它允许 AI 模型:
- 列出和浏览频道
- 向频道发送消息
- 回复线程
- 在消息上添加反应
- 获取频道历史记录
- 获取线程回复
- 列出用户并检索用户资料
✨ 主要特性
- 支持 AI 助手与 Slack 工作区的多种交互操作,如消息发送、线程回复等。
- 提供了一系列 Slack 集成工具,方便使用。
📦 安装指南
# 从 npm 安装
npm install shouting-mcp-slack
# 或者全局安装
npm install -g shouting-mcp-slack
你可以在 npm 上找到该包:shouting-mcp-slack
先决条件
你需要设置一个 Slack 机器人并获得必要的凭证:
- 在 Slack API 控制台 中创建一个 Slack 应用。
- 添加以下 Bot Token 权限范围:
channels:historychannels:readchat:writereactions:writeusers:readusers:read.email
- 将应用安装到你的工作区。
- 复制 Bot User OAuth Token。
配置
服务器需要以下环境变量:
SLACK_BOT_TOKEN:你的 Slack Bot User OAuth Token。SLACK_TEAM_ID:你的 Slack 团队 ID。
💻 使用示例
基础用法
作为 CLI 工具运行
# 设置环境变量
export SLACK_BOT_TOKEN=xoxb-your-token
export SLACK_TEAM_ID=your-team-id
# 运行服务器
mcp-server-slack
在你的代码中使用
import { Server } from "@modelcontextprotocol/sdk/server/index.js";
import { SlackClient } from "shouting-mcp-slack";
// 初始化服务器和客户端
const server = new Server({...});
const slackClient = new SlackClient(process.env.SLACK_BOT_TOKEN);
// 注册自定义处理程序
// ...
高级用法
服务器提供了以下 Slack 集成工具,可在不同场景下灵活使用:
slack_list_channels:列出可用频道。slack_post_message:向频道发送消息。slack_reply_to_thread:回复线程。slack_add_reaction:在消息上添加反应。slack_get_channel_history:获取频道的消息历史记录。slack_get_thread_replies:获取线程中的回复。slack_get_users:列出工作区的用户。slack_get_user_profile:获取用户的资料。
📄 许可证
ISC
👨💻 作者
shouting.hsiao@gmail.com
🔗 仓库
https://github.com/z9905080/mcp-slack
微信扫一扫