shell_command 接受字符串或字符串数组;数组表示多条命令按工具协议批量执行,不应被误读成单条 argv。
这里跨越工具调用与操作系统进程。状态不会在一次函数返回后消失,而要由 Session 级对象持有,直到退出、取消或回收。 本节只追踪“模型参数形状与 Shell 实际命令边界”以内的机制;相邻工具的业务行为不在这里混写。
启用条件与所有权
| 维度 | 当前实现 | 不满足时 |
|---|---|---|
| 门控 | 存在可用环境且模型/Feature 选择对应 Shell Tool 类型 | 不建立候选、从模型工具面移除,或转成模型可读拒绝 |
| 输入 | Shell Function Payload | 在进入状态所有者前拒绝错误 Payload/参数 |
| 状态所有者 | Shell Handler、ToolOrchestrator 与目标环境执行器 | 不允许临时 Handler 私自复制长期状态 |
| 输出 | ExecToolCallOutput 编码的 FunctionCallOutput | 必须保持调用关联后才能进入 History |
这里最容易出现的误解,是把“规格里写了什么”当作 Runtime 已经强制了什么。description、Schema 和自然语言提示只帮助模型生成更好的调用;真正的名称查找、类型校验、审批、资源约束和取消收尾仍由客户端完成。
机制调用链
构造 Shell Tool Schema
→ 解析 command 联合形状
→ 解析 workdir/timeout
→ 生成 ShellCommand 列表
→ 交给 Runtime
图中的箭头代表控制权转移,不只是数据复制。每越过一步,下一层只接收已经满足上一层合同的数据;若该层拥有异步状态,它还必须保留原 Step、call_id 或环境身份,避免晚到结果被新一轮配置解释。
源码机制拆解
command 不是 argv 数组
字符串数组的每一项是一条 Shell 命令,而不是 program 与 args 的分隔。
这条约束位于“解析 command 联合形状”附近。把它前移会缺少必要状态,把它后移则可能让错误数据或副作用先穿过边界。
可选字段动态出现
allow_login_shell 和 exec permission approvals 决定 login、sandbox_permissions、justification、prefix_rule 是否进入 Schema。
这条约束位于“解析 workdir/timeout”附近。把它前移会缺少必要状态,把它后移则可能让错误数据或副作用先穿过边界。
timeout 是执行超时
毫秒值进入 ExecExpiration,不等同于首次流式 yield。
这条约束位于“生成 ShellCommand 列表”附近。把它前移会缺少必要状态,把它后移则可能让错误数据或副作用先穿过边界。
Python 风格伪代码
伪代码保留会改变结果的门控、状态读取、异步等待和协议编码;省略 Rust 所有权样板、日志字段以及与本机制无关的 Provider 适配。它不是源码翻译,也不能替代平台级安全实现。
async def run_shell_command_spec(request, step, cancellation):
# 1. 构造 Shell Tool Schema
# 2. 解析 command 联合形状
# 3. 解析 workdir/timeout
# 4. 生成 ShellCommand 列表
# 5. 交给 Runtime
shell_request = parse_shell_payload(request, step.session_shell)
requirement = step.exec_policy.evaluate(shell_request.command, step.approval_policy)
if requirement.forbidden:
return FunctionOutput.failed(request.call_id, requirement.reason)
approval = await approve_if_required(requirement, shell_request, step, cancellation)
attempt = step.sandbox_manager.first_attempt(shell_request, approval)
return await run_at_most_one_escalation(shell_request, attempt, step, cancellation)
逐行理解时要抓住三个不变量:输入先验证,状态由明确对象持有,输出用原调用身份编码。任何“先执行,之后再补关联”的简化都会在并发、取消或 Step 更新时产生悬空结果。
失败、取消与恢复
| 故障点 | 已发生的状态或副作用 | 对模型/调用方的结果 | 恢复动作 |
|---|---|---|---|
| 数组含空命令 | 解析阶段拒绝或形成无效项 | 模型收到参数错误 | 删除空项并重试 |
| 字段未在当前 Schema | 旧/不同 Step 参数到达 | Handler 按原 Step 选项处理 | 不得借用下一 Step 规格 |
| Turn 取消 | 可能已经注册等待者、启动任务或提交部分副作用 | 生成 Aborted/Failed 终态,不能留下无结果调用 | 由 Shell Handler、ToolOrchestrator 与目标环境执行器 注销等待者、终止资源并保持 Call/Output 配对 |
取消不是删除历史。模型已经发出的调用先进入转录;Runtime 必须补上可编码的终态。若副作用已经提交,Aborted 也不表示回滚。需要事务性的功能必须在自己的写入协议里实现原子提交或补偿。
设计思路与代价
当前设计保护的核心不变量是:规格只在选项允许时加入 login/approval 字段,Handler 对 string/array 分支分别解析。它让模型合同、执行状态和安全边界能够分别演进,却增加了快照、适配器和终态处理代码。更短的实现可以少一层对象,但会把“可见”“可执行”“获准”“已完成”压成同一个布尔值,无法解释延迟工具、审批拒绝、沙箱失败或晚到结果。
本节的设计动机有一部分是从类型边界和测试行为推断出来的;源码没有把所有取舍写成设计文档。可以直接证明的是字段、分支、状态所有者和失败结果,不能从这些证据外推服务端内部实现。
测试与复现实验
| 可验证契约 | 复现方式 | 预期结果 |
|---|---|---|
| codex-rs/core/src/tools/handlers/shell_tests.rs | 构造正常值、边界值和拒绝值 | 结果与调用 ID/状态所有者保持一致 |
本地复核应同时搜索生产符号和相邻测试,不能只跑快乐路径。推荐先对源码执行 rg -n 查找本节索引中的类型/函数,再构造一个合法调用、一个类型错误和一个取消或拒绝场景。当前环境没有 Cargo,因此本轮以锁定提交下的源码—测试静态对读、博客构建和图形渲染为验证边界,不伪报 Rust 测试执行。
Mini Codex 对照
Mini Codex 可以复刻本节的纯协议或状态机不变量,例如名称去重、调用配对、Head/Tail 缓冲与单次升级;不能用 Python 模拟结果证明 Seatbelt、seccomp、Restricted Token、远程 Exec Server 或 Provider Hosted Tool 的真实安全性质。
本节边界
本节已经证明 规格只在选项允许时加入 login/approval 字段,Handler 对 string/array 分支分别解析。它没有把相邻机制折叠进来:模型参数形状与 Shell 实际命令边界 之外的判断仍由其各自单元负责。
阅读导航
上一节:6.19 取消、Aborted Output 和 Call/Output 配对 · 下一节:6.21 Shell 参数解析、登录 Shell 与平台差异
评论
登录后即可评论