README
🚀 Slack MCP 项目文档
Slack MCP 是一款强大的集成工具,借助 Server-Sent Events (SSE) 或 HTTP 达成实时通信,实现与工具链 (MCP) 的无缝连接。它具备实时日志输出、任务执行状态监控、环境变量管理以及 Slack 团队通知集成等丰富功能,能极大提升工作效率。
🚀 快速开始
要使用 Slack MCP,可按以下步骤进行安装与配置:
📦 安装指南
- 克隆仓库:
git clone https://github.com/yourusername/slack-mcp.git cd slack-mcp - 依赖管理:
- Go 语言项目:
go mod tidy - Python 项目:
pip install -r requirements.txt
- Go 语言项目:
- 构建工具:
make build - 运行服务:
- 开发模式:
go run main.go --mode dev - 生产环境:
go run main.go --mode production
- 开发模式:
🛠️ 配置选项
Slack MCP 提供了一系列可配置选项,你可以通过命令行或配置文件进行设置:
| 属性 | 详情 |
|------|------|
| SLACK_BOT_TOKEN | Slack 机器人令牌,必填 |
| SLACK_APP_TOKEN | Slack 应用令牌,必填 |
| OPENAI_API_KEY | OpenAI API 密钥,必填 |
| OPENAI_MODEL | 使用的 OpenAI 模型,默认值为 "gpt-4o" |
| LOG_LEVEL | 日志级别 (debug, info, warn, error),默认值为 "info" |
| LLM_PROVIDER | LLM 提供商 (openai, ollama 等),默认值为 "openai" |
💻 使用示例
基础用法
# 克隆仓库
git clone https://github.com/yourusername/slack-mcp.git
cd slack-mcp
# 依赖管理(Go 项目)
go mod tidy
# 构建工具
make build
# 以开发模式运行服务
go run main.go --mode dev
✨ 主要特性
- 输出格式丰富:Slack MCP 提供 Slack 格式化输出功能,支持自动格式检测,能自动识别文本类型(纯文本文、Markdown、JSON 块结构等)并应用相应格式;同时支持 Markdown 格式化,可将标准 Markdown 转换为适合 Slack 的格式。
- 多种传输模式:支持三种传输模式,分别是 SSE (默认),使用 Server-Sent Events 实现实时通信;HTTP,通过 HTTP POST 请求进行 JSON-RPC 通信;stdio,使用标准输入输出进行本地开发和测试。
📚 详细文档
传输模式说明
- SSE (默认):使用 Server-Sent Events 实现实时通信,能及时反馈数据变化。
- HTTP:通过 HTTP POST 请求进行 JSON-RPC 通信,适用于常规的数据交互。
- stdio:使用标准输入输出进行本地开发和测试,方便开发者在本地环境进行调试。
🤝 贡献指南
欢迎贡献!请随意提交 Pull Request。
📄 许可证
本项目采用 MIT 许可证,详见 LICENSE 文件。
🚀 CI/CD 和发布
项目使用 GitHub Actions 进行 CI/CD,并通过 Docker 镜像进行分发。
扫码联系在线客服