@drewswiredin/backstage-plugin-assistants-common

中文文档
0.19.0发布于 2026/10/27Apache-2.0TypeScriptESM + CJS近 30 天下载 2419

后台AI助理共享类型和权限.

中文使用文档

@drewswiredin/后台-插件-助手-常见

共享、浏览器安全的类型和后台AI助理的权限 : 双方的合同 前端 财务报告和审定财务报表 后端 软件包。 它有一个运行中的依赖, @backstage/plugin-permission-common。 。 。 .

由两个插件过渡安装. 直接看情况 写入引用插件的权限政策或自定义导航 权限 :

# a permission policy
yarn --cwd packages/backend add @drewswiredin/backstage-plugin-assistants-common
# a custom nav
yarn --cwd packages/app add @drewswiredin/backstage-plugin-assistants-common

出口

权限 :

导出nameaction盖茨
assistantUsePermissionassistant.useread聊天和提供用户路径
assistantManagePermissionassistant.manageupdate管理编辑, /manage/*,以及 /capabilities
assistantsPermissions作为阵列

类型 :

  • AssistantDefinition: canonic 助手形状(一行) assistants 表格; 数据 /manage API和管理员编辑器的模型),与 AssistantAccess (其准入政策)和 UiOptions。 。 。 .
  • AssistantSummary 财务报告和审定财务报表 StatusResponse: 浏览器安全 /status 预测(无即时、无访问政策) ToolSummary 财务报告和审定财务报表 ModelOption。 。 。 .
  • CapabilitiesResponse:编辑器的可分配目录,带有 CapabilityAction 财务报告和审定财务报表 McpServerCapability。 。 。 .
  • AssistantId, (中文(简体) ), ModelId (单位:千美元)<providerId>:<model>, (中文(简体) ), ReasoningLevel 编辑 REASONING_LEVELS 常数( n)low, (中文(简体) ), medium, (中文(简体) ), high, (中文(简体) ), max) (中文(简体) ).
  • StatusResponse.requireApproval:全球核准层作为工具名称, 用于闸门客户端工具.
  • StatusResponse.defaultAssistant,以及 isDefault 打开 AssistantSummary 财务报告和审定财务报表 AssistantDefinition: 默认助手, 每一个签名的用户 获得.
  • PageContext (单位:千美元)path, (中文(简体) ), title, (中文(简体) ), entityRef: 页面旁边的一面 页面随转而发送.

客户端工具(运行于 用户浏览器; 蓝图本身在前端软件包中 :

  • ClientToolAttributes (单位:千美元)readOnly, (中文(简体) ), destructive, (中文(简体) ), idempotent和 ClientToolDeclaration按要求申报description, (中文(简体) ), 杰森·斯克马 parameters, (中文(简体) ), attributes) (中文(简体) ).
  • ClientToolError 财务报告和审定财务报表 ClientToolErrorCode (单位:千美元)declined, (中文(简体) ), not_authorized, (中文(简体) ), timeout, (中文(简体) ), aborted, (中文(简体) ), failed: _error 结果客户端工具返回 而不是扔东西.
  • CLIENT_TOOL_NAME_PATTERN (单位:千美元)<namespace>__<tool>, (中文(简体) ), BUILTIN_CLIENT_TOOLS (单位:千美元)render_form, (中文(简体) ), download_file, (中文(简体) ), read_current_page, (中文(简体) ), describe_portal, (中文(简体) ), CLIENT_TOOL_LIMITS (每件请求30起, 4000-特征描述,8192-特征计划),并 isClientToolName。 。 。 .

用户 MCP 服务器( 浏览器使用用户自己的服务器) 符号 :

  • UserCredentialSpec 联 合 国 AssistantSummary.userCredentials: 标志 a 服务器需要,以及 USER_CREDENTIALS_HEADER (单位:千美元)x-assistants-credentials, (中文(简体) ), 浏览器发送符号的页眉.
  • McpOAuthConnection, (中文(简体) ), McpOAuthStatusResponse, (中文(简体) ), McpOAuthStartResponse,以及 MCP_OAUTH_MESSAGE_TYPE: 运行自己的服务器的连接流 欧奥特.
  • StatusResponse.approveEachCall: 其入门工具不总是使用的服务器 允许.
  • ApprovalPreview, (中文(简体) ), ApprovalPreviewRequest, (中文(简体) ), ApprovalPreviewResponse, (中文(简体) ), StatusResponse.approvalPreviews,以及 resolvePreviewField: diff 是一个 批准卡显示写作.

Eliaction(一个MCP服务器,要求用户输入中调) :

  • ElicitationPrompt, (中文(简体) ), ElicitationStatus, (中文(简体) ), ElicitationField, (中文(简体) ), ElicitationOption,以及 ElicitationResponseRequest。 。 。 .
  • parseElicitationSchema, (中文(简体) ), validateElicitationContent,以及 isSensitiveElicitationField:共享的图解和验证.

平台指令:

  • PLATFORM_INSTRUCTIONS: 后端发送前的固定文本 助手的提示;编辑器显示它只读.

许可证

阿帕奇 - 2.0

版本与发布记录

@drewswiredin/backstage-plugin-assistants-common 共发布 27 个版本,首次发布于 2026/06/04;过去 12 个月发布了 27 个版本。

版本发布日期距今
0.19.0latest2026/10/2717 天前
0.18.12026/10/2717 天前
0.18.02026/10/2321 天前
0.17.02026/10/2321 天前
0.16.02026/10/2321 天前
0.15.12026/10/2222 天前

关于 @drewswiredin/backstage-plugin-assistants-common 的常见问题

@drewswiredin/backstage-plugin-assistants-common 是什么?

后台AI助理共享类型和权限.

如何安装 @drewswiredin/backstage-plugin-assistants-common?

在项目目录运行 npm install @drewswiredin/backstage-plugin-assistants-common,或使用 pnpm add / yarn add / bun add。

@drewswiredin/backstage-plugin-assistants-common 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@drewswiredin/backstage-plugin-assistants-common 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@drewswiredin/backstage-plugin-assistants-common 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.12。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@drewswiredin/backstage-plugin-assistants-common 可以商用吗?

@drewswiredin/backstage-plugin-assistants-common 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@drewswiredin/backstage-plugin-assistants-common 的下载量有多少?

根据 npm 官方下载统计,@drewswiredin/backstage-plugin-assistants-common 在 2026/10/13 – 2026/11/11 这 30 天内被下载 2,419 次,日均约 81 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@drewswiredin/backstage-plugin-assistants-common 还在维护吗?

最新版本 0.19.0 发布于 2026/10/27(17 天前);至今共发布 27 个版本,其中过去 12 个月发布了 27 个;首次发布于 2026/06/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。