Skip to content

Manifest 设计

Manifest 的职责是声明 App 需要什么、提供什么、从哪里加载实现,以及宿主如何安全投影。它不是业务实现本身。

设计原则

  1. APP.md 保持可发现、可读、可审查。
  2. 真实 UI、worker、storage、workflow 放在 runtime package。
  3. 所有 Lime 能力通过 capabilitiesrequires.capabilities 显式声明。
  4. 必需能力和可选能力分开,便于 readiness 降级。
  5. 客户数据、凭证和 tenant overlay 不进入官方 manifest。
  6. 每个 entry 都能追溯到 UI route、worker、workflow、expert persona 或 artifact type。

推荐结构

yaml
name: example-domain-app
version: 0.3.0
status: ready
appType: domain-app
manifestVersion: 0.3.0
runtimeTargets:
  - local
requires:
  lime:
    appRuntime: ">=0.3.0 <1.0.0"
  sdk: "@lime/app-sdk@^0.3.0"
  capabilities:
    lime.ui: "^0.3.0"
    lime.storage: "^0.3.0"
    lime.agent: "^0.3.0"
capabilities:
  - lime.ui
  - lime.storage
  - lime.agent
  - agentskills
runtimePackage:
  ui:
    path: ./dist/ui
  worker:
    path: ./dist/worker
storage:
  namespace: example-domain-app
  schema: ./storage/schema.json
entries:
  - key: dashboard
    kind: page
    title: Dashboard
    route: /dashboard
  - key: advisor
    kind: expert-chat
    title: Advisor
    persona: ./agents/advisor.md

额外要求

  • scene / home 只作为兼容入口;新 App 使用 pagecommandworkflowartifactbackground-tasksettings
  • Product-level App 应声明 runtimePackage,并让每个 entry 能追溯到 UI、worker、workflow、expert 或 artifact。
  • 有可执行 entry、worker、tool adapter 或 secret 时,必须声明 permissions
  • 客户差异进入 overlayTemplates,不要 fork 官方包。

常见错误

  • 把完整业务逻辑写进 APP.md
  • 只声明 expert-chat,却声称是完整 App。
  • App 直接调用 Lime 内部模块而不是 SDK。
  • 每个 App 自己实现文件、存储、Artifact、Knowledge、Tool Broker。
  • 忘记声明 storage migration、secret、network 和 background-task 权限。

Entry 设计表

Entry kind适用场景必须指向
pageDashboard 或 workspace 等 App 自有完整页面。Route 或 UI bundle registration。
panel嵌入宿主 UI 的上下文侧栏。Route、panel placement 和 data contract。
expert-chatApp 内的聊天式专家入口。Persona 文件,以及声明的上下文、工具、策略和可选复用标准。
commandCommand palette 或 slash-command action。Command handler 或 workflow start。
workflow多步骤业务状态机。Workflow descriptor 和可选 worker。
artifact持久输出的 viewer 或 creator。Artifact type descriptor 和 UI viewer。
background-task定时或事件驱动任务。Worker/service descriptor 和 permissions。
settingsApp 配置界面。Settings route 和 overlay/storage policy。

Manifest Review 检查表

  • Identity 字段足够稳定,可支持 registry、cache 和 upgrade。
  • Runtime code 使用能力前,requires 已声明 SDK 和 host capability 版本。
  • Optional capability 的降级行为写在 guide body 中。
  • 每个 entry 有唯一 key,并能追到 runtime implementation。
  • Permissions 描述用户影响,而不只是内部技术 scope。
  • Overlay templates 表达 tenant/workspace customization,不复制官方 package。
  • Compatibility metadata 说明最低 host 版本和迁移约束。

Draft host-platform standard for installable agent applications.