概览

此包提供了类型定义和显示验证符,用于 任务控制代理 (AMC)插件. 它是插件工程的 dev 依赖性 — 它为沙盒提供 TypeScript 接口 PluginContext 您的后端代码收到 AgentMC 浏览器连接您使用的 UI 代码, 以及用于构建时检查的 Zod 动力显示验证器 .

安装

npm install @agent-mc/plugin-sdk --save-dev

使用量

后端类型

import type { PluginActivate, PluginContext } from '@agent-mc/plugin-sdk'

const activate: PluginActivate = (ctx) => {
  return {
    async onEnable() {
      const data = await ctx.storage.get('config')
      ctx.log.info('Plugin enabled', data)
    },
    async onShutdown() {
      ctx.log.info('Goodbye')
    },
  }
}

export default activate

浏览器桥型

import type { AgentMC } from '@agent-mc/plugin-sdk/browser'

declare global {
  interface Window { AgentMC: AgentMC }
}

const settings = await window.AgentMC.settings.getAll()

表面验证

import { validateManifest } from '@agent-mc/plugin-sdk/validators'

const result = validateManifest(manifest)
if (!result.valid) {
  console.error(result.errors)
}

插件连接 API

每个后端插件都收到一个 PluginContext 具有这些沙箱能力:

* 联合国 toast.show() 总是有的;只有 toast.notify() (OS级)要求 notifications 允许.

权限

宣布为 manifest.json AMC在安装和运行时显示:

{
  "permissions": ["storage", "network", "ai"]
}

出口

该套装提供了五个切入点:

后端生命周期

interface PluginBackend {
  onEnable?(): Promise<void> | void
  onDisable?(): Promise<void> | void
  onSettingsChanged?(settings: Record<string, unknown>): Promise<void> | void
  onAppReady?(): Promise<void> | void
  onShutdown?(): Promise<void> | void
}

文档

完整指南、 API 参考和实例 : Omniscio 插件 SDK 文档

• 开始 ——脚手架您的第一个插件
• 参考文献 - 完整清单 json spec
• 权限 ——每次许可所给予的
• 面板命令 ——从面板安全发送命令到后端
• API 参考 - 所有20个能力接口

许可证

麻省理工学院