Slack
Socket 模式(默认)
Section titled “Socket 模式(默认)”快速设置(新手)
Section titled “快速设置(新手)”- 创建一个 Slack 应用并启用 Socket Mode。
- 创建一个 App Token(
xapp-...)和 Bot Token(xoxb-...)。 - 为 CoderClaw 设置令牌并启动 Gateway 网关。
最小配置:
{ channels: { slack: { enabled: true, appToken: "xapp-...", botToken: "xoxb-...", }, },}- 在 https://api.slack.com/apps 创建一个 Slack 应用(从头开始)。
- Socket Mode → 开启。然后前往 Basic Information → App-Level Tokens → Generate Token and Scopes,添加
connections:write权限范围。复制 App Token(xapp-...)。 - OAuth & Permissions → 添加 bot token 权限范围(使用下面的 manifest)。点击 Install to Workspace。复制 Bot User OAuth Token(
xoxb-...)。 - 可选:OAuth & Permissions → 添加 User Token Scopes(参见下面的只读列表)。重新安装应用并复制 User OAuth Token(
xoxp-...)。 - Event Subscriptions → 启用事件并订阅:
message.*(包括编辑/删除/线程广播)app_mentionreaction_added、reaction_removedmember_joined_channel、member_left_channelchannel_renamepin_added、pin_removed
- 邀请机器人加入你希望它读取的频道。
- Slash Commands → 如果你使用
channels.slack.slashCommand,创建/coderclaw。如果启用原生命令,为每个内置命令添加一个斜杠命令(名称与/help相同)。除非你设置channels.slack.commands.native: true,否则 Slack 默认关闭原生命令(全局commands.native是"auto",对 Slack 保持关闭)。 - App Home → 启用 Messages Tab 以便用户可以私信机器人。
使用下面的 manifest 以保持权限范围和事件同步。
多账户支持:使用 channels.slack.accounts 配置每个账户的令牌和可选的 name。参见 gateway/configuration 了解共享模式。
CoderClaw 配置(最小)
Section titled “CoderClaw 配置(最小)”通过环境变量设置令牌(推荐):
SLACK_APP_TOKEN=xapp-...SLACK_BOT_TOKEN=xoxb-...
或通过配置:
{ channels: { slack: { enabled: true, appToken: "xapp-...", botToken: "xoxb-...", }, },}用户令牌(可选)
Section titled “用户令牌(可选)”CoderClaw 可以使用 Slack 用户令牌(xoxp-...)进行读取操作(历史记录、置顶、表情回应、表情符号、成员信息)。默认情况下保持只读:当存在用户令牌时,读取优先使用用户令牌,而写入仍然使用 bot 令牌,除非你明确选择加入。即使设置了 userTokenReadOnly: false,当 bot 令牌可用时,写入仍然优先使用 bot 令牌。
用户令牌在配置文件中配置(不支持环境变量)。对于多账户,设置 channels.slack.accounts.<id>.userToken。
包含 bot + app + 用户令牌的示例:
{ channels: { slack: { enabled: true, appToken: "xapp-...", botToken: "xoxb-...", userToken: "xoxp-...", }, },}明确设置 userTokenReadOnly 的示例(允许用户令牌写入):
{ channels: { slack: { enabled: true, appToken: "xapp-...", botToken: "xoxb-...", userToken: "xoxp-...", userTokenReadOnly: false, }, },}- 读取操作(历史记录、表情回应列表、置顶列表、表情符号列表、成员信息、搜索)在配置了用户令牌时优先使用用户令牌,否则使用 bot 令牌。
- 写入操作(发送/编辑/删除消息、添加/移除表情回应、置顶/取消置顶、文件上传)默认使用 bot 令牌。如果
userTokenReadOnly: false且没有可用的 bot 令牌,CoderClaw 会回退到用户令牌。
channels.slack.historyLimit(或channels.slack.accounts.*.historyLimit)控制将多少条最近的频道/群组消息包含到提示中。- 回退到
messages.groupChat.historyLimit。设置为0以禁用(默认 50)。
HTTP 模式(Events API)
Section titled “HTTP 模式(Events API)”当你的 Gateway 网关可以通过 HTTPS 被 Slack 访问时(服务器部署的典型情况),使用 HTTP webhook 模式。 HTTP 模式使用 Events API + Interactivity + Slash Commands,共享一个请求 URL。
- 创建一个 Slack 应用并禁用 Socket Mode(如果你只使用 HTTP 则可选)。
- Basic Information → 复制 Signing Secret。
- OAuth & Permissions → 安装应用并复制 Bot User OAuth Token(
xoxb-...)。 - Event Subscriptions → 启用事件并将 Request URL 设置为你的 Gateway 网关 webhook 路径(默认
/slack/events)。 - Interactivity & Shortcuts → 启用并设置相同的 Request URL。
- Slash Commands → 为你的命令设置相同的 Request URL。
示例请求 URL:
https://gateway-host/slack/events
CoderClaw 配置(最小)
Section titled “CoderClaw 配置(最小)”{ channels: { slack: { enabled: true, mode: "http", botToken: "xoxb-...", signingSecret: "your-signing-secret", webhookPath: "/slack/events", }, },}多账户 HTTP 模式:设置 channels.slack.accounts.<id>.mode = "http" 并为每个账户提供唯一的 webhookPath,以便每个 Slack 应用可以指向自己的 URL。
Manifest(可选)
Section titled “Manifest(可选)”使用此 Slack 应用 manifest 快速创建应用(如果需要可以调整名称/命令)。如果你计划配置用户令牌,请包含用户权限范围。
{ "display_information": { "name": "CoderClaw", "description": "Slack connector for CoderClaw" }, "features": { "bot_user": { "display_name": "CoderClaw", "always_online": false }, "app_home": { "messages_tab_enabled": true, "messages_tab_read_only_enabled": false }, "slash_commands": [ { "command": "/coderclaw", "description": "Send a message to CoderClaw", "should_escape": false } ] }, "oauth_config": { "scopes": { "bot": [ "chat:write", "channels:history", "channels:read", "groups:history", "groups:read", "groups:write", "im:history", "im:read", "im:write", "mpim:history", "mpim:read", "mpim:write", "users:read", "app_mentions:read", "reactions:read", "reactions:write", "pins:read", "pins:write", "emoji:read", "commands", "files:read", "files:write" ], "user": [ "channels:history", "channels:read", "groups:history", "groups:read", "im:history", "im:read", "mpim:history", "mpim:read", "users:read", "reactions:read", "pins:read", "emoji:read", "search:read" ] } }, "settings": { "socket_mode_enabled": true, "event_subscriptions": { "bot_events": [ "app_mention", "message.channels", "message.groups", "message.im", "message.mpim", "reaction_added", "reaction_removed", "member_joined_channel", "member_left_channel", "channel_rename", "pin_added", "pin_removed" ] } }}如果启用原生命令,为每个要公开的命令添加一个 slash_commands 条目(与 /help 列表匹配)。使用 channels.slack.commands.native 覆盖。
权限范围(当前 vs 可选)
Section titled “权限范围(当前 vs 可选)”Slack 的 Conversations API 是按类型区分的:你只需要你实际接触的会话类型(channels、groups、im、mpim)的权限范围。概述参见 https://docs.slack.dev/apis/web-api/using-the-conversations-api/。
Bot 令牌权限范围(必需)
Section titled “Bot 令牌权限范围(必需)”chat:write(通过chat.postMessage发送/更新/删除消息) https://docs.slack.dev/reference/methods/chat.postMessageim:write(通过conversations.open打开私信用于用户私信) https://docs.slack.dev/reference/methods/conversations.openchannels:history、groups:history、im:history、mpim:historyhttps://docs.slack.dev/reference/methods/conversations.historychannels:read、groups:read、im:read、mpim:readhttps://docs.slack.dev/reference/methods/conversations.infousers:read(用户查询) https://docs.slack.dev/reference/methods/users.inforeactions:read、reactions:write(reactions.get/reactions.add) https://docs.slack.dev/reference/methods/reactions.get https://docs.slack.dev/reference/methods/reactions.addpins:read、pins:write(pins.list/pins.add/pins.remove) https://docs.slack.dev/reference/scopes/pins.read https://docs.slack.dev/reference/scopes/pins.writeemoji:read(emoji.list) https://docs.slack.dev/reference/scopes/emoji.readfiles:write(通过files.uploadV2上传) https://docs.slack.dev/messaging/working-with-files/#upload
用户令牌权限范围(可选,默认只读)
Section titled “用户令牌权限范围(可选,默认只读)”如果你配置了 channels.slack.userToken,在 User Token Scopes 下添加这些。
channels:history、groups:history、im:history、mpim:historychannels:read、groups:read、im:read、mpim:readusers:readreactions:readpins:reademoji:readsearch:read
目前不需要(但未来可能需要)
Section titled “目前不需要(但未来可能需要)”mpim:write(仅当我们添加群组私信打开/私信启动时通过conversations.open)groups:write(仅当我们添加私有频道管理时:创建/重命名/邀请/归档)chat:write.public(仅当我们想发布到机器人未加入的频道时) https://docs.slack.dev/reference/scopes/chat.write.publicusers:read.email(仅当我们需要从users.info获取邮箱字段时) https://docs.slack.dev/changelog/2017-04-narrowing-email-accessfiles:read(仅当我们开始列出/读取文件元数据时)
Slack 仅使用 Socket Mode(无 HTTP webhook 服务器)。提供两个令牌:
{ "slack": { "enabled": true, "botToken": "xoxb-...", "appToken": "xapp-...", "groupPolicy": "allowlist", "dm": { "enabled": true, "policy": "pairing", "allowFrom": ["U123", "U456", "*"], "groupEnabled": false, "groupChannels": ["G123"], "replyToMode": "all" }, "channels": { "C123": { "allow": true, "requireMention": true }, "#general": { "allow": true, "requireMention": true, "users": ["U123"], "skills": ["search", "docs"], "systemPrompt": "Keep answers short." } }, "reactionNotifications": "own", "reactionAllowlist": ["U123"], "replyToMode": "off", "actions": { "reactions": true, "messages": true, "pins": true, "memberInfo": true, "emojiList": true }, "slashCommand": { "enabled": true, "name": "coderclaw", "sessionPrefix": "slack:slash", "ephemeral": true }, "textChunkLimit": 4000, "mediaMaxMb": 20 }}令牌也可以通过环境变量提供:
SLACK_BOT_TOKENSLACK_APP_TOKEN
确认表情回应通过 messages.ackReaction + messages.ackReactionScope 全局控制。使用 messages.removeAckAfterReply 在机器人回复后清除确认表情回应。
- 出站文本按
channels.slack.textChunkLimit分块(默认 4000)。 - 可选的换行分块:设置
channels.slack.chunkMode="newline"以在长度分块之前按空行(段落边界)分割。 - 媒体上传受
channels.slack.mediaMaxMb限制(默认 20)。
默认情况下,CoderClaw 在主频道回复。使用 channels.slack.replyToMode 控制自动线程:
| 模式 | 行为 |
|---|---|
off | 默认。 在主频道回复。仅当触发消息已在线程中时才使用线程。 |
first | 第一条回复进入线程(在触发消息下),后续回复进入主频道。适合保持上下文可见同时避免线程混乱。 |
all | 所有回复都进入线程。保持对话集中但可能降低可见性。 |
该模式适用于自动回复和智能体工具调用(slack sendMessage)。
按聊天类型的线程
Section titled “按聊天类型的线程”你可以通过设置 channels.slack.replyToModeByChatType 为每种聊天类型配置不同的线程行为:
{ channels: { slack: { replyToMode: "off", // 频道的默认值 replyToModeByChatType: { direct: "all", // 私信始终使用线程 group: "first", // 群组私信/MPIM 第一条回复使用线程 }, }, },}支持的聊天类型:
direct:一对一私信(Slackim)group:群组私信 / MPIM(Slackmpim)channel:标准频道(公开/私有)
优先级:
replyToModeByChatType.<chatType>replyToMode- 提供商默认值(
off)
当未设置聊天类型覆盖时,旧版 channels.slack.dm.replyToMode 仍可作为 direct 的回退。
示例:
仅对私信使用线程:
{ channels: { slack: { replyToMode: "off", replyToModeByChatType: { direct: "all" }, }, },}对群组私信使用线程但保持频道在根级别:
{ channels: { slack: { replyToMode: "off", replyToModeByChatType: { group: "first" }, }, },}让频道使用线程,保持私信在根级别:
{ channels: { slack: { replyToMode: "first", replyToModeByChatType: { direct: "off", group: "off" }, }, },}手动线程标签
Section titled “手动线程标签”对于细粒度控制,在智能体响应中使用这些标签:
[[reply_to_current]]— 回复触发消息(开始/继续线程)。[[reply_to:<id>]]— 回复特定的消息 id。
会话 + 路由
Section titled “会话 + 路由”- 私信共享
main会话(与 WhatsApp/Telegram 相同)。 - 频道映射到
agent:<agentId>:slack:channel:<channelId>会话。 - 斜杠命令使用
agent:<agentId>:slack:slash:<userId>会话(前缀可通过channels.slack.slashCommand.sessionPrefix配置)。 - 如果 Slack 未提供
channel_type,CoderClaw 会从频道 ID 前缀(D、C、G)推断并默认为channel以保持会话键稳定。 - 原生命令注册使用
commands.native(全局默认"auto"→ Slack 关闭),可以使用channels.slack.commands.native按工作空间覆盖。文本命令需要独立的/...消息,可以使用commands.text: false禁用。Slack 斜杠命令在 Slack 应用中管理,不会自动移除。使用commands.useAccessGroups: false绕过命令的访问组检查。 - 完整命令列表 + 配置:斜杠命令
私信安全(配对)
Section titled “私信安全(配对)”- 默认:
channels.slack.dm.policy="pairing"— 未知的私信发送者会收到配对码(1 小时后过期)。 - 通过以下方式批准:
coderclaw pairing approve slack <code>。 - 要允许任何人:设置
channels.slack.dm.policy="open"和channels.slack.dm.allowFrom=["*"]。 channels.slack.dm.allowFrom接受用户 ID、@用户名或邮箱(在令牌允许时启动时解析)。向导在设置期间接受用户名,并在令牌允许时将其解析为 ID。
channels.slack.groupPolicy控制频道处理(open|disabled|allowlist)。allowlist要求频道列在channels.slack.channels中。- 如果你只设置了
SLACK_BOT_TOKEN/SLACK_APP_TOKEN而从未创建channels.slack部分,运行时默认将groupPolicy设为open。添加channels.slack.groupPolicy、channels.defaults.groupPolicy或频道白名单来锁定它。 - 配置向导接受
#channel名称,并在可能时(公开 + 私有)将其解析为 ID;如果存在多个匹配,它优先选择活跃的频道。 - 启动时,CoderClaw 将白名单中的频道/用户名解析为 ID(在令牌允许时)并记录映射;未解析的条目按原样保留。
- 要不允许任何频道,设置
channels.slack.groupPolicy: "disabled"(或保留空白名单)。
频道选项(channels.slack.channels.<id> 或 channels.slack.channels.<name>):
allow:当groupPolicy="allowlist"时允许/拒绝频道。requireMention:频道的提及门控。tools:可选的每频道工具策略覆盖(allow/deny/alsoAllow)。toolsBySender:频道内可选的每发送者工具策略覆盖(键为发送者 id/@用户名/邮箱;支持"*"通配符)。allowBots:允许此频道中机器人发送的消息(默认:false)。users:可选的每频道用户白名单。skills:Skills 过滤器(省略 = 所有 Skills,空 = 无)。systemPrompt:频道的额外系统提示(与主题/目的组合)。enabled:设置为false以禁用频道。
与 cron/CLI 发送一起使用:
user:<id>用于私信channel:<id>用于频道
Slack 工具操作可以通过 channels.slack.actions.* 进行门控:
| 操作组 | 默认 | 说明 |
|---|---|---|
| reactions | 已启用 | 表情回应 + 列出表情回应 |
| messages | 已启用 | 读取/发送/编辑/删除 |
| pins | 已启用 | 置顶/取消置顶/列表 |
| memberInfo | 已启用 | 成员信息 |
| emojiList | 已启用 | 自定义表情符号列表 |
- 写入默认使用 bot 令牌,因此状态更改操作保持在应用的机器人权限和身份范围内。
- 设置
userTokenReadOnly: false允许在 bot 令牌不可用时使用用户令牌进行写入操作,这意味着操作以安装用户的访问权限运行。将用户令牌视为高权限,并保持操作门控和白名单严格。 - 如果你启用用户令牌写入,请确保用户令牌包含你期望的写入权限范围(
chat:write、reactions:write、pins:write、files:write),否则这些操作将失败。
- 提及门控通过
channels.slack.channels控制(将requireMention设置为true);agents.list[].groupChat.mentionPatterns(或messages.groupChat.mentionPatterns)也算作提及。 - 多智能体覆盖:在
agents.list[].groupChat.mentionPatterns上设置每智能体的模式。 - 表情回应通知遵循
channels.slack.reactionNotifications(在allowlist模式下使用reactionAllowlist)。 - 默认忽略机器人发送的消息;通过
channels.slack.allowBots或channels.slack.channels.<id>.allowBots启用。 - 警告:如果你允许回复其他机器人(
channels.slack.allowBots=true或channels.slack.channels.<id>.allowBots=true),请使用requireMention、channels.slack.channels.<id>.users白名单和/或在AGENTS.md和SOUL.md中设置明确的防护措施来防止机器人之间的回复循环。 - 对于 Slack 工具,表情回应移除语义见 /tools/reactions。
- 附件在允许且在大小限制内时会下载到媒体存储。