Documentation Index
Fetch the complete documentation index at: https://openclaw.zhcndoc.com/llms.txt
Use this file to discover all available pages before exploring further.
openclaw mcp 有两个职责:
- 使用
openclaw mcp serve将 OpenClaw 作为 MCP 服务器运行 - 使用
list、show、set和unset管理 OpenClaw 拥有的出站 MCP 服务器定义
serve是 OpenClaw 作为 MCP 服务器运行list/show/set/unset是 OpenClaw 作为 MCP 客户端侧注册表,用于其运行时后续可能消费的其他 MCP 服务器
openclaw acp。
OpenClaw 作为 MCP 服务器
这就是openclaw mcp serve 路径。
何时使用 serve
在以下情况下使用 openclaw mcp serve:
- Codex、Claude Code 或其他 MCP 客户端应直接与由 OpenClaw 支持的频道对话
- 你已经有一个带有路由会话的本地或远程 OpenClaw Gateway
- 你希望使用一个适用于 OpenClaw 各频道后端的 MCP 服务器,而不是为每个频道分别运行桥接
openclaw acp。
工作原理
openclaw mcp serve 会启动一个 stdio MCP 服务器。MCP 客户端拥有该进程。在客户端保持 stdio 会话打开期间,桥接通过 WebSocket 连接到本地或远程 OpenClaw Gateway,并通过 MCP 暴露已路由的频道对话。
重要行为
重要行为
- 实时队列状态从桥接连接时开始
- 较早的转写历史通过
messages_read读取 - Claude 推送通知只在 MCP 会话存活期间存在
- 当客户端断开连接时,桥接退出,实时队列也会消失
openclaw agent和openclaw infer model run等一次性代理入口在回复完成时会退役其打开的任何捆绑 MCP 运行时,因此重复的脚本运行不会累积 stdio MCP 子进程- OpenClaw 启动的 stdio MCP 服务器(捆绑的或用户配置的)会在关闭时作为进程树被拆除,因此由服务器启动的子进程不会在父级 stdio 客户端退出后继续存活
- 删除或重置会话会通过共享运行时清理路径释放该会话的 MCP 客户端,因此不会残留与已移除会话关联的 stdio 连接
选择客户端模式
同一个桥接可以用两种不同方式使用:- 通用 MCP 客户端
- Claude Code
仅使用标准 MCP 工具。使用
conversations_list、messages_read、events_poll、events_wait、messages_send 和审批工具。目前,
auto 的行为与 on 相同。尚未进行客户端能力检测。serve 暴露什么
该桥接使用现有的 Gateway 会话路由元数据来暴露由频道支持的对话。当 OpenClaw 已经拥有具有已知路由的会话状态时,会显示一个对话,例如:
channel- 接收方或目标元数据
- 可选的
accountId - 可选的
threadId
- 列出最近的路由对话
- 读取最近的转写历史
- 等待新的入站事件
- 通过同一路由发送回复
- 查看桥接连接期间到达的审批请求
用法
- 本地 Gateway
- 远程 Gateway(token)
- 远程 Gateway(password)
- 详细日志 / 关闭 Claude
桥接工具
当前桥接暴露以下 MCP 工具:conversations_list
conversations_list
列出最近的、已绑定会话的对话,这些对话在 Gateway 会话状态中已经有路由元数据。有用的过滤条件:
limitsearchchannelincludeDerivedTitlesincludeLastMessage
conversation_get
conversation_get
通过
session_key 使用直接的 Gateway 会话查找返回一个对话。messages_read
messages_read
读取一个已绑定会话对话的最近转写消息。
attachments_fetch
attachments_fetch
从一条转写消息中提取非文本消息内容块。这是对转写内容的元数据视图,而不是独立的持久化附件 blob 存储。
events_poll
events_poll
从一个数值游标开始读取已排队的实时事件。
events_wait
events_wait
长轮询直到下一个匹配的已排队事件到达或超时结束。当通用 MCP 客户端需要接近实时的投递,但不使用 Claude 特定推送协议时,请使用这个工具。
messages_send
messages_send
通过会话上已记录的同一路由发送文本回复。当前行为:
- 需要一个现有的对话路由
- 使用会话的 channel、recipient、account id 和 thread id
- 仅发送文本
permissions_list_open
permissions_list_open
列出桥接自连接到 Gateway 以来观察到的待处理 exec/plugin 审批请求。
permissions_respond
permissions_respond
使用以下之一解决一个待处理的 exec/plugin 审批请求:
allow-onceallow-alwaysdeny
事件模型
桥接在连接期间会维护一个内存中的事件队列。 当前事件类型:messageexec_approval_requestedexec_approval_resolvedplugin_approval_requestedplugin_approval_resolvedclaude_permission_request
Claude 频道通知
该桥接还可以暴露 Claude 特定的频道通知。这是 OpenClaw 对 Claude Code 频道适配器的对应实现:标准 MCP 工具仍然可用,但实时入站消息也可以作为 Claude 特定的 MCP 通知到达。- off
- on
- auto(默认)
--claude-channel-mode off:仅使用标准 MCP 工具。notifications/claude/channelnotifications/claude/channel/permission
- 入站
user转写消息会作为notifications/claude/channel转发 - 通过 MCP 接收的 Claude 权限请求会在内存中跟踪
- 如果链接的对话后来发送了
yes abcde或no abcde,桥接会将其转换为notifications/claude/channel/permission - 这些通知仅在实时会话中有效;如果 MCP 客户端断开连接,就没有推送目标了
MCP 客户端配置
stdio 客户端配置示例:选项
openclaw mcp serve 支持:
Gateway WebSocket URL。
Gateway token。
从文件读取 token。
Gateway 密码。
从文件读取密码。
Claude 通知模式。
在 stderr 上输出详细日志。
安全性与信任边界
桥接不会凭空创造路由。它只暴露 Gateway 已经知道如何路由的对话。 这意味着:- 发送方允许列表、配对以及频道级信任仍然属于底层 OpenClaw 频道配置
messages_send只能通过现有已存储的路由进行回复- 审批状态仅对当前桥接会话是实时的、内存中的
- 桥接认证应使用与任何其他远程 Gateway 客户端相同的 Gateway token 或 password 控制
conversations_list 中缺少某个对话,通常原因不是 MCP 配置有问题,而是底层 Gateway 会话中缺少或不完整的路由元数据。
测试
OpenClaw 为此桥接提供了确定性的 Docker 冒烟测试:- 启动一个带种子的 Gateway 容器
- 启动第二个容器来运行
openclaw mcp serve - 验证对话发现、转写读取、附件元数据读取、实时事件队列行为,以及出站发送路由
- 通过真实的 stdio MCP 桥接验证 Claude 风格的频道和权限通知
故障排查
未返回任何对话
未返回任何对话
通常表示 Gateway 会话尚不可路由。请确认底层会话已存储 channel/provider、recipient,以及可选的 account/thread 路由元数据。
events_poll 或 events_wait 漏掉了较早的消息
events_poll 或 events_wait 漏掉了较早的消息
这是预期行为。实时队列从桥接连接时开始。请使用
messages_read 读取更早的转写历史。Claude 通知没有出现
Claude 通知没有出现
请检查以下所有项:
- 客户端保持了 stdio MCP 会话打开
--claude-channel-mode为on或auto- 客户端确实理解 Claude 特定的通知方法
- 入站消息发生在桥接连接之后
缺少审批
缺少审批
permissions_list_open 只显示桥接连接期间观察到的审批请求。它不是一个持久的审批历史 API。作为 MCP 客户端注册表的 OpenClaw
这是openclaw mcp list、show、set 和 unset 的路径。
这些命令不会通过 MCP 暴露 OpenClaw。它们管理 OpenClaw 配置中 mcp.servers 下由 OpenClaw 拥有的 MCP 服务器定义。
这些已保存的定义适用于 OpenClaw 后续启动或配置的运行时,例如嵌入式 Pi 和其他运行时适配器。OpenClaw 将这些定义集中存储,因此这些运行时不需要维护自己重复的 MCP 服务器列表。
重要行为
重要行为
- 这些命令只读取或写入 OpenClaw 配置
- 它们不会连接到目标 MCP 服务器
- 它们不会验证当前命令、URL 或远程传输是否可达
- 运行时适配器会在执行时决定它们实际支持哪些传输形式
- 嵌入式 Pi 会在普通
coding和messaging工具配置文件中暴露已配置的 MCP 工具;minimal仍然会隐藏它们,而tools.deny: ["bundle-mcp"]会显式禁用它们 - 作用域为会话的捆绑 MCP 运行时会在空闲
mcp.sessionIdleTtlMs毫秒后被清理(默认 10 分钟;设为0可禁用),一次性嵌入式运行会在运行结束时清理它们
transport 值,而 Claude Code 和 Gemini 接收 CLI 原生的 type 值,例如 http、sse 或 stdio。
已保存的 MCP 服务器定义
OpenClaw 还会在配置中存储一个轻量级的 MCP 服务器注册表,用于希望使用 OpenClaw 管理的 MCP 定义的界面。 命令:openclaw mcp listopenclaw mcp show [name]openclaw mcp set <name> <json>openclaw mcp unset <name>
list会按服务器名称排序。- 不带名称的
show会打印完整配置的 MCP 服务器对象。 set期望在命令行中提供一个 JSON 对象值。- 对于 Streamable HTTP MCP 服务器,请使用
transport: "streamable-http"。openclaw mcp set还会将 CLI 原生的type: "http"规范化为相同的标准配置形状以兼容。 - 如果指定名称的服务器不存在,
unset会失败。
Stdio 传输
启动一个本地子进程,并通过 stdin/stdout 通信。| Field | Description |
|---|---|
command | 要启动的可执行文件(必需) |
args | 命令行参数数组 |
env | 额外的环境变量 |
cwd / workingDirectory | 进程的工作目录 |
SSE / HTTP 传输
通过 HTTP Server-Sent Events 连接到远程 MCP 服务器。| Field | Description |
|---|---|
url | 远程服务器的 HTTP 或 HTTPS URL(必需) |
headers | HTTP 头的可选键值映射(例如认证令牌) |
connectionTimeoutMs | 每个服务器的连接超时时间,单位为 ms(可选) |
url 中的敏感值(userinfo)和 headers 会在日志和状态输出中被隐藏。
Streamable HTTP 传输
streamable-http 是与 sse 和 stdio 并列的另一种传输选项。它使用 HTTP 流式传输与远程 MCP 服务器进行双向通信。
| Field | Description |
|---|---|
url | 远程服务器的 HTTP 或 HTTPS URL(必需) |
transport | 设为 "streamable-http" 以选择此传输;如果省略,OpenClaw 将使用 sse |
headers | HTTP 头的可选键值映射(例如认证令牌) |
connectionTimeoutMs | 每个服务器的连接超时时间,单位为 ms(可选) |
transport: "streamable-http" 作为标准写法。通过 openclaw mcp set 保存时会接受 CLI 原生的 MCP type: "http" 值,并由 openclaw doctor --fix 修复现有配置,但 transport 才是嵌入式 Pi 直接使用的值。
示例:
这些命令只管理已保存的配置。它们不会启动通道桥接、打开一个实时的 MCP 客户端会话,也不能证明目标服务器可达。
当前限制
此页面记录的是当前随版本发布的桥接功能。 当前限制:- 会话发现依赖于现有的 Gateway 会话路由元数据
- 除了 Claude 特定适配器之外,没有通用的推送协议
- 目前还没有消息编辑或反应工具
- HTTP/SSE/streamable-http 传输连接到单个远程服务器;尚未支持多路复用上游
permissions_list_open只包含桥接连接期间观察到的审批