dwsy/pi-gateway-plugin-dev

Pi Gateway Plugin Dev 技能

用于在 gateway 模式 开发插件，不是 pi extension。

适用边界

• 目标是扩展 pi-gateway 的连接层能力（消息通道、HTTP/WS、命令、服务）
• 插件加载位置是 ~/.pi/gateway/plugins/ 或 plugins.dirs[] 指定目录
• 插件必须有 plugin.json，并通过 main 指向入口文件

以下场景不要用本技能：

• 修改 Agent 思维、提示词、工具执行行为（那是 ~/.pi/agent/extensions 的职责）
• 仅在 CLI/TUI 中运行、不经过 gateway 的功能

强制规范

1. 每个插件一个独立目录（<plugins-root>/<plugin-id>/）。
2. 禁止单文件模式：不能只放一个 index.ts 就结束。
3. 入口文件只做组装，不写核心业务逻辑。
4. 业务按职责拆分到 src/commands.ts、src/rpc-methods.ts、src/hooks.ts、src/services.ts、src/types.ts。
5. 插件只在 gateway 插件机制里加载，不放到 ~/.pi/agent/extensions/。

标准目录

<plugins-root>/<plugin-id>/
  plugin.json
  src/
    index.ts
    types.ts
    commands.ts
    rpc-methods.ts
    hooks.ts
    services.ts

工作流

1. 先判定是 Gateway 插件需求（不是 pi extension）。
2. 阅读目录规范：references/plugin-directory-architecture.md
3. 阅读 SDK 接口：references/sdk-capabilities.md
4. 阅读 RPC 能力映射：references/rpc-capabilities.md
5. 如涉及模型能力，读取：references/model-control-pattern.md
6. 用脚手架生成插件目录，再填业务逻辑。
7. 在 pi-gateway.json 里配置 plugins.dirs[] 并启动验证。

脚手架命令

bash skills/pi-gateway-plugin-dev/scripts/new-plugin.sh ~/.pi/gateway/plugins model-control "Model Control"

生成后会得到完整多文件插件目录，不会退化为单 index.ts。

模型能力实现策略

• 切模型：用 GatewayPluginApi.setModel(sessionKey, provider, modelId)。
• 调思考强度：用 GatewayPluginApi.setThinkingLevel(sessionKey, level)。
• 列模型：当前 GatewayPluginApi 不直接暴露 getAvailableModels，推荐复用网关内置 models.list / /api/models。
• 若必须插件内部直连 RPC：先扩展 GatewayPluginApi + createPluginApi + RpcClient 映射，见 references/rpc-capabilities.md 的"扩展路径"。

工具流式支持 (Tool Streaming)

pi-gateway 工具支持流式执行，通过 onPartialResult 回调实时更新进度：

工具执行方法签名

async execute(
  toolCallId: string,
  args: unknown,
  signal: AbortSignal,
  onPartialResult?: (partial: ToolResult) => void
): Promise<ToolResult>

实现流式工具

// src/tools/my-streaming-tool.ts
export function createMyStreamingTool() {
  return {
    name: "my_streaming_tool",
    parameters: Type.Object({
      text: Type.String(),
      stream: Type.Optional(Type.Boolean({ default: true })),
    }),
    async execute(
      _toolCallId: string,
      params: unknown,
      signal: AbortSignal,
      onPartialResult?: (partial: ToolResult) => void
    ) {
      const { text, stream } = params as { text: string; stream?: boolean };
      
      if (!stream) {
        // 非流式：直接返回结果
        return { content: [{ type: "text", text }] };
      }
      
      // 流式：分块处理，每块调用 onPartialResult
      const chunks = splitIntoChunks(text, 80);
      let accumulated = "";
      
      for (let i = 0; i < chunks.length; i++) {
        if (signal?.aborted) {
          return { content: [{ type: "text", text: "Aborted" }], details: { error: true } };
        }
        
        accumulated += chunks[i];
        
        // 报告进度
        if (onPartialResult) {
          onPartialResult({
            content: [{ type: "text", text: accumulated + (i < chunks.length - 1 ? "…" : "") }],
            details: { progress: i + 1, total: chunks.length },
          });
        }
        
        // 模拟处理延迟
        await new Promise((resolve) => setTimeout(resolve, 100));
      }
      
      return {
        content: [{ type: "text", text: accumulated }],
        details: { completed: true, chunks: chunks.length },
      };
    },
  };
}

关键要点

1. AbortSignal 处理: 检查 signal.aborted 支持取消操作
2. PartialResult 结构: 包含 content 数组和可选的 details 元数据
3. 视觉反馈: 使用 … 或其他指示符表示还有更多内容
4. 渐进式更新: 每完成一个阶段就调用 onPartialResult，不要等全部完成

参考实现

查看 send_message 工具的流式实现：

• extensions/gateway-tools/send-message.ts

交付要求

• 输出插件目录树
• 输出 plugin.json 和关键源文件
• 说明如何在 gateway 模式加载（plugins.dirs[]）
• 给出最小验证命令（至少覆盖"列模型/切模型"或对应能力）
• （可选）如果工具支持流式，提供流式调用示例