Tool Approval

为待执行工具操作展示说明,并请求明确决策。

适用场景

  • 当界面需要以下行为时使用 Tool Approval:为待执行工具操作展示说明,并请求明确决策。

安装

选择安装方式,用法示例将同步更新导入路径。

$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/tool-approval.json

首次使用时,将安装的 src/components/orvui/styles.css 导入项目样式入口。

示例

预览

Allow this tool to run?
terminal.run
Approval required

The agent wants to run the project test suite in the current workspace.

Command
pnpm exec vitest run tests/a11y.test.ts
Directory
ui-components

组合结构

使用公开部件 ToolApproval, ToolApprovalCode 组合 Tool Approval,并从该组件的公开入口导入。

Message
└── MessageContent
    └── ToolApproval
        └── ToolApprovalCode

说明: Approval Card 在助手继续工作前,引导用户完成一个或多个决策步骤。 Agent Activity 将持续变化的助手活动组织为可展开步骤与完成摘要。 Tool Result 在同一表面呈现工具调用状态、摘要与可展开结果。

工作方式

为待执行工具操作展示说明,并请求明确决策。

状态与事件

需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。

组件状态绑定
组件Vue 绑定更新事件
ToolApprovalv-model:openbooleanupdate:open

可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。

API 参考

ToolApproval

tool
Content
—
title?
boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>
"Allow this tool to run?"
description?
boolean | null | string | number | void | VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNodeArrayChildren | ComponentOptions<any, any, any, ComputedOptions, MethodOptions, any, any, any, string, {}, {}, string, {}, {}, {}, string, ComponentProvideOptions> | FunctionalComponent<any, {}, any, {}> | ComponentPublicInstanceConstructor<any, any, any, any, ComputedOptions, MethodOptions>
—
parameters?
ToolApprovalParameter[]
() => []
status?
"error" | "complete" | "pending" | "approved" | "running" | "approving" | "denied"
"pending"
open?
boolean
undefined
defaultOpen?
boolean
false

事件

update:open
[open: boolean]
@update:open
openChange
[open: boolean]
@openChange
approve
[]
@approve
alwaysAllow
[]
@alwaysAllow
deny
[]
@deny

插槽

default
() => VNodeChild
#default

ToolApprovalCode

code
string
—
language?
"text" | "bash" | "diff" | "json" | "tsx" | "typescript" | "javascript" | "vue" | "css" | "html"
"bash"

无障碍

为交互控件提供明确的无障碍名称。保留文档中的键盘路径、可见焦点与减少动态效果状态;自定义插槽应继续保留所替代部件的语义。

常见问题

如何配置 Tool Approval?
通过 tool、title、description、parameters、status、open、defaultOpen 配置 Tool Approval;API 表列出其类型与默认值。
如何连接到应用状态?
监听 update:open、openChange、approve、alwaysAllow、deny,将组件连接到应用状态。
可以在服务端渲染吗?
可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。

更新于