Keyboard shortcuts

Press or to navigate between chapters

Press ? to show this help

Press Esc to hide this help

Discord

将你的 ZeroClaw 智能体作为 Discord 机器人运行。本指南将逐步带你完成操作,无需任何机器人开发经验。完成后,你将拥有一个驻留在服务器中的机器人,当有人与它对话时它会作出回复。

谁可以与代理通信

入站发送方会根据为绑定代理解析出的对等集合进行限制,该集合来自代理所属的 peer_groups 配置。匹配时会去除开头的 @,并对通道的原生发送方标识符执行不区分大小写的比对。集合会拒绝所有人;包含 "*" 的集合会接受所有人;否则仅接受列出的外部对等方(以及对等代理)。这与网关配对(gateway.require_pairing)不同,后者验证的是 HTTP/WebSocket 客户端,而非聊天通道的发送方。

用于 discord 的对等组将 channel 设置为 discord,在 external_peers 中列出允许的发送者(对于 discord,即 Discord 用户 ID(snowflake);["*"] 接受任何人),可选地命名对等 agents 以进行跨代理调度、一个 ignore 屏蔽列表,以及一个 output_modalitymirrorvoicetext)。字段参考请参见 Peer Groups

在何处设置:

网关仪表板

在 Web 仪表板中打开 /config/peer_groups

zerocode

Config 窗格中的 Peer groups 下。

快速开始

五个步骤:创建机器人、复制它的令牌、打开两个开关、邀请它,然后启动 ZeroClaw。

1. 创建机器人

  1. 前往 Discord 开发者门户
  2. 单击 New Application,为其命名,然后单击 Create
  3. 在左侧边栏中,单击 Bot
  4. 点击 Reset Token,然后点击 Copy。这串很长的字符就是你的 bot_token。请妥善保存以备第 3 步使用,之后你将无法再次查看(只能重置)。

机器人令牌是你的机器人的密码。任何拥有它的人都可以控制你的机器人。切勿将其粘贴到公开聊天、截图中,或提交到 git。

2. 开启机器人所需的两个开关

仍在 Bot 页面,向下滚动到 Privileged Gateway Intents,并将这两个选项都开启:

  • Message Content Intent,使机器人能够读取用户输入的内容。
  • 服务器成员意图(Server Members Intent),以便它能查看服务器中有哪些成员。

点击 Save Changes。如果跳过此步骤,机器人虽然能连接但无法接收任何消息,这正是“机器人毫无反应”最常见的原因。

3. 将机器人信息告知 ZeroClaw

将步骤 1 中的令牌放入你的配置。该令牌是机密信息,因此请通过可以加密它的方式进行设置,而不要直接键入到 config.toml 中:

网关仪表板

在 Web 控制台中打开 /config/channels/discord

zerocode

Config 窗格中,Channels 下。

channels.discord.<alias>.bot_token 是一项机密信息。 它以加密形式存储,绝不会以明文形式保存在 config.toml 中。请通过以下方式之一进行设置,这些方式会在写入时进行加密:

网关仪表板

打开 /config/channels/discord 并在其中设置 channels.discord.<alias>.bot_token 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.bot_token 字段(输入内容会被遮蔽)。

zeroclaw config

zeroclaw config set channels.discord.<alias>.bot_token    # 提示输入掩码内容,以加密形式存储

4. 邀请机器人加入你的服务器

  1. 回到 Developer Portal,打开 OAuth2 -> URL Generator
  2. Scopes 下,勾选 bot
  3. Bot Permissions 下,至少勾选 Send MessagesRead Message HistoryView Channels
  4. 复制底部的 URL,在浏览器中打开它,选择你的服务器,然后点击 Authorize

机器人现在会显示在你的成员列表中(在你启动 ZeroClaw 之前显示为离线状态)。

5. 启动并测试

启动 ZeroClaw(zeroclaw service restartzeroclaw daemon),然后在机器人可见的频道中发送一条消息。它应该会回复。如果没有回复,请跳转到故障排查

配置

完整字段列表派生自实时架构。大多数字段都有合理的默认值;对于基本的机器人,你只需设置 bot_token

approval_timeout_secs integer · default 300

always_ask 工具等待操作员批准的秒数,超时后自动拒绝。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.approval_timeout_secs 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.approval_timeout_secs 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.approval_timeout_secs <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__approval_timeout_secs=
archive bool · default false

为 true 时,该通道会打开一个伴随的 discord.db SQLite 记忆后端,归档它看到的每一条非机器人消息,并针对该后端注册 discord_search 工具。默认值:false。从旧版 [channels.discord-history] 块合并而来。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.archive 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.archive 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.archive <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__archive=
bot_token 🔑 secret · default ""

Discord 机器人令牌(来自 Discord Developer Portal)。#[serde(default)] 的原因与 TelegramConfig::bot_token 相同:缺失的令牌必须反序列化为空字符串,而不是在补救时丢弃该别名;一旦 enabled = truevalidate_bot_token 仍然要求提供真实令牌。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.bot_token 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.bot_token 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.bot_token    # 掩码输入,加密存储

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__bot_token=
channel_ids string[] · default []

要监视的频道 ID。留空 = 监视机器人可见的每个频道。由归档附属程序(当 archive = true 时)使用,并在设置后由频道内过滤器使用。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.channel_ids 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.channel_ids 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.channel_ids <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__channel_ids=
draft_update_interval_ms integer · default 1000

草稿消息编辑之间的最小间隔(毫秒),用于避免触发速率限制。仅在 stream_mode = "partial" 时使用。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.draft_update_interval_ms 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.draft_update_interval_ms 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.draft_update_interval_ms <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__draft_update_interval_ms=
excluded_tools string[] · default []

从此通道的工具规范中排除的工具。设置后,通过此通道响应时不会向模型公开这些工具。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.excluded_tools 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.excluded_tools 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.excluded_tools <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__excluded_tools=
guild_ids string[] · default []

限制机器人使用的公会(服务器)ID。留空 = 监听机器人被邀请加入的所有公会。从旧版的 guild_id 单数字段迁移而来。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.guild_ids 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.guild_ids 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.guild_ids <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__guild_ids=
intents_mask integer? · default null

原始网关意图掩码覆盖。设置后,将在 IDENTIFY 中发送此确切值,而非派生掩码:这是为通过自定义构建或分支消费网关事件的下游部署提供的操作员应急通道。操作员需自行承担后果:特权位仍需在 Developer Portal 中开启对应开关,而丢弃基线位会导致消息处理静默失效(会记录一条警告)。未设置(默认)= 根据频道的功能配置派生掩码。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.intents_mask 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.intents_mask 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.intents_mask <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__intents_mask=
interrupt_on_new_message bool · default false

为 true 时,来自同一频道中同一发送者的较新 Discord 消息会取消正在处理的请求,并在保留历史记录的情况下重新开始响应。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.interrupt_on_new_message 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.interrupt_on_new_message 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.interrupt_on_new_message <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__interrupt_on_new_message=
listen_to_bots bool · default false

为 true 时,处理来自其他机器人的消息(而不仅仅是人类的消息)。机器人仍会忽略自己的消息,以防止反馈循环。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.listen_to_bots 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.listen_to_bots 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.listen_to_bots <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__listen_to_bots=
mention_only bool · default false

为 true 时,仅响应 @ 提及该机器人的消息。服务器中的其他消息将被静默忽略。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.mention_only 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.mention_only 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.mention_only <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__mention_only=
multi_message_delay_ms integer · default 800

多消息模式下,发送每个消息块之间的延迟(毫秒)。仅在 stream_mode = "multi_message" 时使用。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.multi_message_delay_ms 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.multi_message_delay_ms 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.multi_message_delay_ms <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__multi_message_delay_ms=
proxy_url string? · default null

每个通道的代理 URL(http、https、socks5、socks5h)。仅为此通道覆盖全局 [proxy] 设置。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.proxy_url 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.proxy_url 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.proxy_url <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__proxy_url=
reaction_notifications DiscordReactionScope · default "off"

记录哪些入站表情回应:off(默认值:甚至不会向网关请求表情回应事件)、own(对机器人消息的表情回应)或 all(对任何通过频道过滤器的消息的表情回应)。当启用 archive 时,记录的表情回应会归档到 discord.db,并在用户移除其表情回应时再次移除(批量清除、remove-all / remove-emoji 尚未被清扫)。设置 intents_mask 会覆盖派生的掩码:如果其中省略了表情回应 intent,则不会记录任何内容。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.reaction_notifications 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.reaction_notifications 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.reaction_notifications <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__reaction_notifications=
reply_min_interval_secs integer · default 0

每个(通道,接收方)出站节流下限(秒)。范围:0..=REPLY_MIN_INTERVAL_MAX_SECS(0 表示禁用)。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.reply_min_interval_secs 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.reply_min_interval_secs 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.reply_min_interval_secs <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__reply_min_interval_secs=
reply_queue_depth_max integer · default 0

每个(channel, recipient)出站节流队列的深度。取值范围:0..=REPLY_QUEUE_DEPTH_CEILING。当 reply_min_interval_secs > 0 且此值为 0 时,节流封装器会使用 DEFAULT_REPLY_QUEUE_DEPTH(16)作为替代值。当队列已满时,最新的发送会被丢弃,并记录一条 WARN 日志。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.reply_queue_depth_max 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.reply_queue_depth_max 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.reply_queue_depth_max <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__reply_queue_depth_max=
slash_command_scope SlashCommandScope · default "global"

已注册斜杠命令的作用域:global(默认,应用范围,约 1 小时传播)或 guild(注册到每个 guild_ids 条目,立即生效)。只有在 slash_commands = true 时才有意义;在 guild_ids 为空时使用 guild 会发出警告并回退到全局。切换作用域会清除当前非活动作用域中所属的命令;注意,从 guild_ids 中“移除”某个 guild(而不切换作用域)不会清除该 guild 的命令——要清除它们,请将 bot 从该 guild 中移除,或切换作用域。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.slash_command_scope 字段。

zerocode

Config 面板中,设置 channels.discord.<alias>.slash_command_scope 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.slash_command_scope <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__slash_command_scope=
slash_commands bool · default false

为 true 时,除消息处理外,还会通过 Gateway WebSocket 注册并提供 Discord 斜杠命令(例如 /ask)。默认为 false。(原型:目前仅注册单个 /ask <prompt>。)

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.slash_commands 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.slash_commands 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.slash_commands <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__slash_commands=
stall_timeout_secs integer · default 0

停滞监视器超时时间(秒)。当值非零时,如果在此时间内没有进展,机器人将中止并重试。0 = 禁用。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.stall_timeout_secs 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.stall_timeout_secs 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.stall_timeout_secs <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__stall_timeout_secs=
stream_mode StreamMode · default "off"

流式模式,用于渐进式传递响应。off(默认):单条消息。partial:可编辑的草稿更新。multi_message:在段落边界处将响应拆分为多条独立消息。

将它放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.stream_mode 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.stream_mode 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.stream_mode <value>

环境变量

导出此覆盖配置(POSIX shell;可放入 ~/.bashrc~/.zshrc.env 或 Dockerfile 中)。将 <alias> 替换为实际的别名:

export ZEROCLAW_channels__discord__<alias>__stream_mode=

缩小机器人监听的范围

默认情况下,机器人会在它被邀请加入的每个服务器以及它能看到的每个频道中进行监听。要缩小其作用范围:

  • guild_ids:将该机器人限制在特定服务器(公会)中。留空表示所有服务器。
  • channel_ids:将其限制为特定频道。留空表示所有可见频道。

若要查找 ID,请在 Discord 中启用开发者模式(用户设置 -> 高级),然后右键单击服务器或频道并选择复制 ID

线程与上下文

当 Discord 对话发生在某个帖子(thread)中时,该帖子即为一个独立的对话。ZeroClaw 会为每个帖子派生出不同的会话密钥,因此每个帖子都拥有独立的上下文窗口和历史记录:某个帖子中的消息绝不会渗入另一个帖子,且智能体也无法看到同级帖子中较早的对话轮次。对于 Discord 而言,帖子是原生频道,因此每个帖子本身就是一个独立的对话:无需设置任何开关。

  • 隔离正是关键所在。 每个线程的上下文都是自包含的:它不会泄漏到线程之外,线程之外的任何内容也不会泄漏进来。并行线程持有各自独立的对话状态,因此互不相关的任务永远不会相互干扰。
  • 长线程会增大上下文。 线程在保持活动状态期间会累积历史记录,因此与其他长对话一样,过长的线程最终会填满模型的上下文窗口。开始新线程即可重置。
  • 进行中的工作以线程为单位进行隔离。 在某个线程中发送新消息不会取消另一个线程中进行中的响应;每个线程的任务都是独立的。

归档和搜索

archive = true 设置为开启后,该频道会打开一个附属的 discord.db 记忆存储,记录它所看到的每一条消息,并注册一个 discord_search 工具供代理用来查找过去的对话。如果你不需要历史搜索,可以将其保持关闭;无论哪种方式,机器人仍会正常回复。

流式传输

Discord 通过 stream_mode 设置来流式传输回复:

  • off(默认):整条回复在 agent 完成后作为一条消息发送。最简单,且永远不会显示写到一半的答案。
  • partial:机器人会立即发布一条草稿,并在答案流式传输的过程中就地编辑它。draft_update_interval_ms 用于控制编辑的节奏;如果 Discord 对编辑进行速率限制,请调高此值。
  • multi_message:每个段落作为独立消息发送,以 multi_message_delay_ms 间隔分隔。适用于较长的回答,避免内容堆积成一大段文字。

将其放置在任何表面上:

网关仪表板

打开 /config/channels/discord 并设置 channels.discord.<alias>.stream_mode 字段。

zerocode

Config 窗格中,设置 channels.discord.<alias>.stream_mode 字段。

zeroclaw config

zeroclaw config set channels.discord.<alias>.stream_mode <value>

让人感觉自然的回复

  • mention_only:设置为 true 时,机器人仅回复 @ 提及它的消息,从而在繁忙的频道中保持安静。
  • reply_min_interval_secs:对同一个人回复之间的最小间隔,如果即时回复显得过于机械,此设置会很有用。

故障排除

症状可能的原因修复
机器人在线但从不回复消息内容 Intent 已关闭在开发者门户中启用它(步骤 2)并重启
机器人不在任何地方回复未受邀请,或缺少“查看频道”/“发送消息”权限使用正确的权限重新运行邀请(步骤 4)
机器人忽略大多数消息mention_only = true@-提及该机器人,或将其设置为 false
启动时出现“Invalid token”令牌输入错误或已重置在门户中重置令牌,然后重新设置(步骤 3)

另见