@gencode/plugin-sdk 0.0.6 → 0.0.7

package/README.md

@@ -112,7 +112,7 @@ WebSocket / callback 中的事件载荷核心字段：
 
 插件可以通过 `api.registerUiTool()` 注册 UI 工具，让 LLM 在需要时暂停 agent 并通过前端表单收集结构化用户输入。
 
-与 `registerTool` 不同，插件只需要提供表单 schema 和基本元数据 — session 绑定、暂停/恢复流程、结果校验都由框架自动完成。
+与 `registerTool` 不同，插件只需要提供 schema 和基本元数据。`inputSchema` 用于定义 LLM 调用这个工具时的参数结构，`outputSchema` 用于定义前端要渲染和回传的表单结构；session 绑定、暂停/恢复流程、结果校验都由框架自动完成。
 
 ### 基本用法
 
@@ -124,7 +124,7 @@ export default function register(api: PluginApi) {
     name: "collect_feedback",
     label: "收集用户反馈",
     description: "Collect structured feedback from the user.",
-    schema: {
+    outputSchema: {
       type: "object",
       title: "用户反馈",
       properties: {
@@ -146,7 +146,7 @@ export default function register(api: PluginApi) {
 
 ### JSON Schema 约定
 
-`schema` 现在遵循 JSON Schema 风格的对象定义，推荐至少提供：
+`outputSchema` 遵循 JSON Schema 风格的对象定义，推荐至少提供：
 
 | 字段 | 说明 |
 |------|------|
@@ -162,7 +162,7 @@ export default function register(api: PluginApi) {
 示例：
 
 ```ts
-schema: {
+outputSchema: {
   type: "object",
   title: "报告参数",
   properties: {
@@ -197,7 +197,7 @@ api.registerUiTool({
   name: "custom_summary_form",
   label: "自定义摘要表单",
   description: "Collect values through a custom-rendered panel.",
-  schema: {
+  outputSchema: {
     type: "object",
     title: "摘要确认",
     properties: {
@@ -242,7 +242,7 @@ api.registerUiTool({
   name: "date_range",
   label: "选择日期范围",
   description: "Collect a date range with cross-field validation.",
-  schema: {
+  outputSchema: {
     type: "object",
     title: "日期范围",
     properties: {
@@ -272,7 +272,7 @@ api.registerUiTool({
 | 维度 | `registerTool` | `registerUiTool` |
 |------|---------------|-----------------|
 | 用途 | 通用工具 | 收集前端表单输入 |
-| 开发者关注点 | 完整 `execute` 实现 | 只需提供 JSON Schema + 元数据 |
+| 开发者关注点 | 完整 `execute` 实现 | 只需提供 `inputSchema?` + `outputSchema` + 元数据 |
 | sessionId | 需要自行处理 | 框架自动绑定 |
 | 暂停/恢复 | 需要手动抛出信号 | 框架自动处理 |
 | 结果校验 | 自行实现 | 内置 JSON Schema 校验 + 可选自定义 validator |
@@ -280,8 +280,8 @@ api.registerUiTool({
 ### 运行流程
 
 1. LLM 调用 UI 工具 → 自动抛出 `UiToolPauseSignal` 暂停 agent
-2. Runner 捕获信号，发出 `ui_tool_request` 进度事件（包含表单 schema）
-3. 前端根据 schema 渲染标准表单，或结合 `extra` 渲染自定义 UI
+2. Runner 捕获信号，发出 `ui_tool_request` 进度事件（包含 `outputSchema`）
+3. 前端根据 `outputSchema` 渲染标准表单，或结合 `extra` 渲染自定义 UI
 4. 用户提交后，CLI 带 `uiToolResume` 重新调用 agent
 5. 框架自动校验数据（内置 + 自定义 validator）
 6. 校验通过 → 工具返回提交值给 LLM → agent 继续执行
@@ -292,7 +292,8 @@ api.registerUiTool({
 
 - `PluginUiToolDescriptor` — `registerUiTool` 的参数类型
 - `PluginUiToolOptions` — 可选参数（如 `optional`）
-- `UiToolSchema` — 表单 schema
+- `UiToolInputSchema` — LLM 调用参数 schema
+- `UiToolOutputSchema` / `UiToolSchema` — 表单 schema
 - `UiToolJsonSchemaProperty` — 单个字段的 JSON Schema 定义
 - `UiToolJsonSchemaType` — 支持的 JSON Schema `type`
 - `UiToolExtra` — 前端扩展渲染负载

package/dist/index.d.ts

@@ -2,10 +2,10 @@
  * @gencode/plugin-sdk
  * Thin re-export layer for plugin authors.
  */
-export type { AgentCustomProgressEvent, PluginApi, PluginRegistry, PluginRecord, PluginDiagnostic, PluginKind, PluginOrigin, PluginManifest, PluginManifestLoadResult, PluginConfigUiHint, PluginProgressEmitter, PluginCustomProgressInput, PluginUiToolDescriptor, PluginUiToolOptions, } from "@gencode/agents";
+export type { UiToolInputSchema, AgentCustomProgressEvent, PluginApi, PluginRegistry, PluginRecord, PluginDiagnostic, PluginKind, PluginOrigin, PluginManifest, PluginManifestLoadResult, PluginConfigUiHint, PluginProgressEmitter, PluginCustomProgressInput, PluginUiToolDescriptor, PluginUiToolOptions, } from "@gencode/agents";
 export type { MemoryProvider, MemoryProviderContext, MemoryProviderFactory, MemoryProviderRegistration, MemorySearchOptions, MemoryChangeSource, MemoryChangedEvent, MemoryChangedHandler, } from "@gencode/agents";
 export type { EmbeddingProvider, EmbeddingProviderContext, EmbeddingProviderFactory, EmbeddingProviderRegistration, } from "@gencode/agents";
 export type { PluginHookName, PluginHookHandlerMap, PluginHookAgentContext, PluginHookBeforeModelResolveEvent, PluginHookBeforeModelResolveResult, PluginHookBeforePromptBuildEvent, PluginHookBeforePromptBuildResult, PluginHookLlmInputEvent, PluginHookLlmOutputEvent, PluginHookBeforeToolCallEvent, PluginHookBeforeToolCallResult, PluginHookAfterToolCallEvent, PluginHookAgentEndEvent, PluginHookBeforeCompactionEvent, PluginHookAfterCompactionEvent, PluginHookSessionStartEvent, PluginHookSessionEndEvent, PluginHookSessionResetEvent, PluginHookMemoryChangedEvent, } from "@gencode/agents";
 export type { PluginRuntime } from "@gencode/agents";
-export type { UiToolExtra, UiToolJsonSchemaProperty, UiToolJsonSchemaType, UiToolSchema, UiToolValidationError, UiToolValidationResult, } from "@gencode/shared";
+export type { UiToolExtra, UiToolOutputSchema, UiToolJsonSchemaProperty, UiToolJsonSchemaType, UiToolSchema, UiToolValidationError, UiToolValidationResult, } from "@gencode/shared";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACV,wBAAwB,EACxB,SAAS,EACT,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,UAAU,EACV,YAAY,EACZ,cAAc,EACd,wBAAwB,EACxB,kBAAkB,EAClB,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,EACtB,mBAAmB,GACpB,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EACV,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACrB,0BAA0B,EAC1B,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EACV,iBAAiB,EACjB,wBAAwB,EACxB,wBAAwB,EACxB,6BAA6B,GAC9B,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,sBAAsB,EACtB,iCAAiC,EACjC,kCAAkC,EAClC,gCAAgC,EAChC,iCAAiC,EACjC,uBAAuB,EACvB,wBAAwB,EACxB,6BAA6B,EAC7B,8BAA8B,EAC9B,4BAA4B,EAC5B,uBAAuB,EACvB,+BAA+B,EAC/B,8BAA8B,EAC9B,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,4BAA4B,GAC7B,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGrD,YAAY,EACV,WAAW,EACX,wBAAwB,EACxB,oBAAoB,EACpB,YAAY,EACZ,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACV,iBAAiB,EACjB,wBAAwB,EACxB,SAAS,EACT,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,UAAU,EACV,YAAY,EACZ,cAAc,EACd,wBAAwB,EACxB,kBAAkB,EAClB,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,EACtB,mBAAmB,GACpB,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EACV,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACrB,0BAA0B,EAC1B,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EACV,iBAAiB,EACjB,wBAAwB,EACxB,wBAAwB,EACxB,6BAA6B,GAC9B,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,sBAAsB,EACtB,iCAAiC,EACjC,kCAAkC,EAClC,gCAAgC,EAChC,iCAAiC,EACjC,uBAAuB,EACvB,wBAAwB,EACxB,6BAA6B,EAC7B,8BAA8B,EAC9B,4BAA4B,EAC5B,uBAAuB,EACvB,+BAA+B,EAC/B,8BAA8B,EAC9B,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,4BAA4B,GAC7B,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGrD,YAAY,EACV,WAAW,EACX,kBAAkB,EAClB,wBAAwB,EACxB,oBAAoB,EACpB,YAAY,EACZ,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,iBAAiB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gencode/plugin-sdk",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -17,8 +17,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@gencode/agents": "0.0.42",
-    "@gencode/shared": "0.0.14"
+    "@gencode/agents": "0.0.43",
+    "@gencode/shared": "0.0.15"
   },
   "devDependencies": {
     "typescript": "^5.9.3"