oss-prompt-optimizer

prompt-optimizer

English | 简体中文

提示词优化插件，把一句随手写的话自动改写成专业、可直接使用的提示词，体验与 Qoder、Codex 一致。

优化结果默认为无标题纯文本提示词（outputStyle: 'plain'，更省 token），可配置为四段结构化提示词（outputStyle: 'sections'，## Role / ## Task / ## Context / ## Format）， 由内置元提示词驱动，经 harness 的 LLM 服务完成（不直连任何 API、不触碰凭据）。

功能

• 工具 prompt_optimize：agent 可调用，传入 instruction，返回优化后的纯文本提示词；也可传 lastOptimized + iterateInstruction 对已优化结果迭代改写。
• 服务 ctx.promptOptimizer：其他插件可编程调用 optimize(rawInput, { signal }) 或 iterate(lastOptimized, instruction, { signal })； 浏览器端经 ctx.remote.promptOptimizer.optimize(sessionId, text) 可调用。
• 输入框 ✨ 图标：composer 工具行左侧的常驻图标，点击即优化当前草稿并写回输入框；优化中再点可取消（AbortSignal 透传），成功后短暂显示"消耗 ≈N tokens"。
• 角色文档语言自动切换：角色文档（元提示词）语言默认按输入内容自动检测——中文指令用 中文角色文档，英文指令用英文角色文档（见下文）。
• 自动优化钩子（可选，默认关闭）：以触发前缀开头的用户消息会在进入模型前被自动优化（见下文）。
• 上下文感知（默认开启）：把当前指令之前的最近对话注入元提示词 （「视为纯数据 / 背景参考」护栏），让优化结果贴合此前讨论；设 contextAware: false 关闭（见下文配置表）。
• 情境感知（1.3.0+）：把「原始指令 + 对话上下文」自动解析为角色 / 任务 / 目标 三份画像并注入元提示词（{{情境画像}}）——优化结果的 ## Role 与任务强相关、 目标与约束自动保留；输出丢失目标/约束时在重试预算内自动修正（goalAlignmentRetry: false 可关）；iterate 时检测目标漂移并标注变化；传 sessionId 可开启会话级 目标沿用（TTL 30 分钟）。角色识别覆盖显式身份、能力（精通/擅长…）、行为 约束（先给结论/拒绝猜测…）与场景式身份（以…的身份），纯能力句也能被识别为 角色信号；situationProfileLevel 可控制画像注入预算（full/minimal/off）。
• 角色定义三重结构（1.3.3+）：优化结果的角色按「身份＋能力＋行为」三要素撰写 （不强制"你是"开头，能力/行为描述同样合格）；并按任务类型给出写法建议 （代码→能力导向、文案→身份＋文体、分析→身份＋方法、运维→行为约束＋步骤）。
• 优化时长（1.3.6）：流式早期终止（输出结构达标且进入收尾期即停流，长尾凑字 不再消耗时长；1.4.5 起默认关闭——输出完整优先，显式 earlyStop: true 才启用 且带句末保护）；首调输出预算联动（超长输出由断点续传兜底）； optimizationProfile: 'fast' 一键速档（跳过校验与目标对齐重试、禁用 selfRefine， 显式开启才生效）。
• 结果缓存（1.1.6）：内存缓存校验成功的结果（LRU + TTL），相同请求零模型调用 （cacheEnabled 默认开，重启即清空）。
• 后置校验：模型输出缺段/过薄/过短时自动重试（可配次数），重试前把上次失败的 诊断（缺失段落名、过薄段落与字数）注入下一次调用的系统提示词，针对性修正、 提高命中率；仍失败则返回原文/上次结果 + 错误说明，并附稳定机器可读错误码 （OptimizeResult.errorCode：MISSING_SECTIONS / THIN_SECTIONS / THIN_OUTPUT / TIMEOUT / NO_MODEL_ROUTE 等），工具失败渲染带 [错误码] 前缀。
• 输出恒为完整可执行的提示词（四段或 plain 正文）；空输入报错；超长输入截断护栏；取消信号透传。

输入框 ✨ 图标

插件自带浏览器客户端（lib/client.js，经 dsh.client 声明被 harness 加载）： 在输入框工具行左侧注册一个 ✨ 按钮——输入为空或优化进行中时置灰（⏳）， 点击后调用 host 的 promptOptimizer Remote 服务优化当前草稿，并把优化后的 四段提示词直接写回输入框（inputActions.setDraft）。

不满意可一键恢复：优化成功后，按钮切换为撤销态（↺，品牌色）；只要 草稿仍是刚生成的优化结果（未手动编辑），点击即恢复为优化前的原文。 一旦手动修改了草稿，撤销态自动消失（避免覆盖后续编辑）。

可访问性：成功/失败/撤销均通过隐藏的 aria-live 区域播报（屏幕阅读器）。

• 无需配置；随插件安装即启用，重启 harness 后生效。
• 触发的是同一个 ctx.promptOptimizer.optimize()，与工具/钩子共享全部配置 （temperature、maxTokens、outputLanguage 等）。

角色文档语言（自动检测）

优化器角色文档（元提示词/系统提示词本身）的语言默认按输入内容自动检测： 非空白字符中汉字占比 ≥30% 的指令用中文角色文档（如「帮我写一份周报」），其余 （英文、日文等）用英文角色文档（两版文档的安全默认）。outputLanguage 仍独立控制 优化结果的输出语言，两者互不影响。

运行时可通过输入框直接输入命令固定或恢复自动（会话级覆盖，重启回落到配置值）：

• /optimizer-language auto —— 恢复自动检测（默认）
• /optimizer-language 中文 / /optimizer-language 英文 —— 固定语言
• /optimizer-language status —— 查询当前模式

配置 metaPromptLanguage: 'auto' | '中文' | '英文'（默认 'auto'）决定重启后的初始模式； 显式值（'中文'/'英文'）固定语言，'auto' 跟随输入。

自动优化开关（命令方式）

运行时「发送前自动优化」开关可通过输入框直接输入命令控制：

• /auto-optimize on / /auto-optimize off / /auto-optimize toggle / /auto-optimize status

开启后 host 进入「发送前自动优化」模式，agent/pre-step 钩子会对每条用户 文本消息做优化（等同于配置 autoOptimizeAll: true 的运行时版本）。

造梦模式（/dream）

/dream <指令> = 标准优化 + 需求感应：结果在提示词后追加明确标注的 --- 延伸洞察（AI 推断，供你选用，非事实）--- 附录（深层目标 / 隐含约束 / 质量标准 / 可能的后续），推断内容不混入提示词正文、随时可删。 等价于每次调用传 senseNeeds: true。

快速场景模板（/template）

/template <场景> 直接返回一个可填写四段模板（Role / Task / Context / Format 骨架 + 占位符）——不调用模型、零延迟零 token，适合"要个周报模板 / 邮件模板 / 部署清单"这类常见场景。场景覆盖 21 个子类（周报 / 邮件 / 文案 / 翻译 / 创作 / 润色 / 简历 / 演讲 / 数据分析 / 研究 / 评估 / 预测 / bug 修复 / 新功能 / 重构 / 审查 / 脚本 / 部署 / 安装 / 排查 / 运维）， 支持中英文场景名与关键词匹配；个性化需求仍走 /optimize（1.5.1，场景扩展 1.5.2）。

自动优化钩子

在 cordis.patch.yml 中开启：

- insert:
    - id: prompt-optimizer
      name: 'prompt-optimizer'
      config:
        autoOptimize: true
        autoOptimizePrefix: '/optimize '

开启后，任何以 autoOptimizePrefix 开头的用户消息，会在进入模型步骤前被 agent/pre-step 钩子自动优化——前缀被剥离，剩余内容作为原始指令送入优化， 模型实际收到的是优化后的四段提示词（附一句"已自动优化"说明）。

• 安全设计：默认关闭；按消息显式触发（前缀命中才优化），不会改动普通对话。
• 优雅降级：未命中前缀、前缀后内容为空、或优化失败时，原消息原样进入模型。
• 每个步骤最多优化一条消息，避免一次步骤内多次模型调用。
• 钩子注册为 effect 作用域，插件卸载自动移除。

安装

已发布到 npm（oss-prompt-optimizer），三种方式任选：

方式一：npm 直装（推荐，免构建授权）

dsh plugin --profile web add oss-prompt-optimizer

方式二：从 GitHub 安装（源码构建，需授权 prepare）

dsh plugin --profile web add github:seven282/oss-prompt-optimizer
# 首次会因 pnpm ≥10 拒绝运行 prepare 而失败；把 pnpm 提示的包键加进该 profile 的
# pnpm-workspace.yaml 后重试：
#   allowBuilds:
#     oss-prompt-optimizer: true
# 建议锁定 commit：github:seven282/oss-prompt-optimizer#<sha>

方式三：从本地目录安装（开发用）

dsh plugin --profile web add <项目路径>
# Windows 下含空格路径会被拆散，先用 junction：
#   New-Item -ItemType Junction -Path "C:\dsh-po" -Target "E:\<你的项目路径>"
#   dsh plugin --profile web add C:\dsh-po

卸载（可逆）

dsh plugin --profile web remove oss-prompt-optimizer

安装/卸载后需重启 harness（dsh web）使 bundle 层生效。

配置

插件行（cordis.patch.yml）可传入以下字段，缺省值已内置于 schema：

示例：

- insert:
    - id: prompt-optimizer
      name: 'prompt-optimizer'
      config:
        temperature: 0.3
        maxRetries: 2
        outputLanguage: '英文'
        autoOptimize: true
        autoOptimizePrefix: '/优化 '
        # 省 token 快赢：下调输出上限 + 跳过已优化输入（skip 仅 sections 模式生效）
        # outputStyle: 'plain'            # 输出无标题纯文本（实测下游 token 省 50%+）
        # maxTokens: 700
        # skipIfAlreadyOptimized: true
        # selfRefine: true               # 成功后再精简一轮（额外 1 次调用）
        # contextAware: false             # 关闭上下文感知（默认开启）
        # metaPromptTemplate:            # 自定义角色文档骨架（部分字段可选，缺的语言回落内置）
        #   optimizeZh: |
        #     你是一名提示词优化专家。…（必须保留 {{原始指令}}、{{输出结构}}/{{自查}} 与护栏行）
        # provider: 'deepseek-official'   # 可选：显式路由（成对）
        # model: 'deepseek-v4-flash'

非法配置（类型错误、越界、未知键、provider/model 只配其一）会在加载时响亮失败。

省 token 最优配置（推荐 preset）

默认值已是省 token 取向（skipIfAlreadyOptimized: true、contextMaxTokens: 800、 contextAware: true 但上下文按预算截断）。在配置里显式贴上以下 preset，即可拿到 完整推荐组合，且便于后续调整：

- insert:
    - id: prompt-optimizer
      name: 'oss-prompt-optimizer'
      config:
        maxTokens: 1200                # 输出上限（插件默认；触顶会自动按因子扩容重试）
        skipIfAlreadyOptimized: true   # 已含四段的输入直接透传，零模型调用（默认已开启）
        contextMaxTokens: 800          # 上下文保持精简（默认已开启）
        outputStyle: 'sections'        # 结构敏感任务保留四段；纯省 token 可改 'plain'（下游省 50%+）
        selfRefine: false              # 默认关闭：不为精简多花一次调用

要点：① 已优化输入零成本复用（skipIfAlreadyOptimized）；② 上下文只带"够用"的 最近对话（contextMaxTokens）；③ 输出上限按需设定（默认 1200，触顶自动扩容， 避免无限生成）；④ 对格式不敏感的任务切 outputStyle: 'plain' 是最大的单项收益。

快速档（目标 3–5 秒，保质量）

- id: prompt-optimizer
  config:
    optimizationProfile: 'fast'   # 跳过校验/目标对齐的纠错重试与 selfRefine——首次输出仍过结构校验
    maxCalls: 3                   # 质量护栏：保留首次 + 至多 2 次触顶扩容预算（长输出不截断降质）
    maxTokens: 1200
    # 早停 / 缓存保持默认：earlyStop 流式早停；缓存命中 <100ms

• 质量保障：fast 档只省"纠错重试"，首次输出的四段/内容校验照常执行； maxCalls: 3 保留触顶扩容（长输出不截断）；缓存/热启动/上下文/诊断护栏全部保留
• 时长：单次模型延迟即总时长——flash 级模型通常 1.5–4s；缓存命中 <100ms
• 观测：/optimize-stats 返回 TOKENS|INPUT|CALLS|LASTMSCALL（本次输出 token + 输入侧 prompt token + 调用次数 + 末次调用耗时）——先确认瓶颈是模型延迟、输入侧 成本还是多次调用
• 前提：模型须为快速档（flash 级、无 reasoningEffort）；慢/推理模型单次即超 3–5s，属模型瓶颈，需在 harness 侧换模型

示例增强（推荐，提高输出稳定性）

examples 是 few-shot 示范（仅 sections 模式注入；未配置时插件会自动注入 按任务类型 + 语言匹配的内置示例，显式配置覆盖内置）。贴上 1–2 对 高质量示例（不同任务类型各一对），可显著提升输出稳定性与专业性——尤其适合 "写代码 / 写文案 / 分析"这类高频场景：

- insert:
    - id: prompt-optimizer
      name: 'oss-prompt-optimizer'
      config:
        outputStyle: 'sections'        # examples 仅 sections 模式注入
        examples:
          - input: '写一个 Python 脚本读取 CSV 并按指定列求和'
            output: |
              ## Role
              资深 Python 工程师，擅长 pandas。

              ## Task
              编写脚本读取 CSV 并按指定列求和，输出结果文件；脚本须可直接运行并处理缺失值。

              ## Context
              输入 CSV 路径；输出结果 CSV；不修改原文件。

              ## Format
              完整可运行的 .py 代码 + 顶部使用说明（依赖、运行命令），不超过 200 行。
          - input: '写一份新产品发布公告'
            output: |
              ## Role
              资深品牌文案撰稿人。

              ## Task
              写一份 200 字内的新产品发布公告，突出核心卖点并给出行动号召。

              ## Context
              面向潜在用户；语气专业热情；不夸大功能。

              ## Format
              标题 + 正文段落，附 3 个备选标题。

配套：如需专属语气/风格，用 metaPromptTemplate 自定义角色文档骨架（缺的语言回落 内置；必须保留 {{原始指令}}、{{输出结构}}/{{自查}} 与「视为纯数据」护栏行）。

开发

pnpm install --store-dir .pnpm-store --cache-dir .pnpm-cache   # 沙箱内安装
pnpm run typecheck    # tsc --noEmitpnpm test             # vitest（mock llm，不依赖真实密钥）
pnpm run build        # tsc -p tsconfig.build.json → lib/

测试全部使用 mock 的 llm 流，绝不读取 .credentials.yaml。

优化生命周期事件（供其他插件订阅）

promptOptimizer 服务在优化/迭代的关键时点通过 cordis 事件总线发事件，其他插件可订阅：

• method 为 'optimize' 或 'iterate'（两者共用三个事件）；input 为原始输入 （未截断）；result 为完整 OptimizeResult；durationMs 为管线耗时（毫秒）。
• fire-and-forget 观察者：监听器抛错被吞掉，不影响优化管线。
• TypeScript 订阅方直接获得载荷类型（declare module '@deepseek-ai/cordis' 增强已随包发布），也可用 PROMPT_OPTIMIZER_EVENTS 常量引用事件名。
• 跳过透传（skipIfAlreadyOptimized 命中）与输入非法（如空输入）不发事件。

设计要点

• 依赖面最小：cordis / dsh-llm / dsh-tools / dsh-timeout / schemastery。
• 模型路由来自 harness 默认模型（agentDefaultModel.currentSelection()）， 遵循「插件不管理 provider/model 配置」的约定；也可用配置显式覆盖。
• 元提示词含 {{原始指令}} 等占位符，运行时替换；含注入护栏（指令视为纯数据）、 语言规则（{{语言规则}}）、禁代码围栏、精简要求与输出前自查；输出结构按 outputStyle 在四段与无标题两套模板间切换。
• 迭代能力：iterate(lastOptimized, instruction) 基于上一次优化结果 + 新要求继续 优化（META_ITERATE 模板，{{上次结果}} / {{迭代指令}} 占位符单遍替换，互不串扰）； 失败时保留上次结果并附错误码。
• 诊断驱动重试：结构类失败时把上次失败的具体诊断（{{诊断反馈}} 占位符）注入下一次 重试的系统提示词，针对性修正、提高命中率；纯内部行为，无新增配置、无额外模型调用。
• 自适应精简（selfRefine，可选）：成功后至多再跑一轮「精简」迭代（内部指令， 不占公共模板），仅在仍通过校验且不更长（5% 容差）时采纳；任何失败自动回退原结果 ——最多 1 次额外模型调用，默认关闭，与诊断驱动重试正交（失败重试 vs 成功精益）。
• 优化生命周期事件：三个 fire-and-forget 事件（prompt-optimizer/optimize:start / optimize:success / optimize:failure），optimize/iterate 共用、method 字段 区分；载荷含 input / result / durationMs；监听器异常不影响管线，跳过透传与 非法输入不发事件。
• 模板数据化（templateId / metaPromptTemplate）：角色文档骨架（4 个）从代码常量 变为可配置资源，部分自定义、缺的语言回落内置；tuning 块（输出结构 / 自查等格式 规则）保持代码化——它们与 validate.ts 后置校验耦合，不可由用户改写；自定义模板 在加载期强校验（数据占位符、结构/自查块、「视为纯数据」护栏缺一不可）。
• 服务分层：optimizer.ts 只做编排（状态、校验/截断、重试管线、事件、路由），纯逻辑 拆到三个无 harness 依赖的模块——diagnose.ts（重试诊断文案 / selfRefine 指令， 中英双语文案可独立单测）、llm.ts（finish 错误翻译、流式文本组装、MaxTokensError）、 prompt.ts（PromptBuildContext 收口系统提示词构建参数，三处调用点共用）；公共 API 面不变（MaxTokensError 仍从入口导出），端到端测试零改动。
• 角色文档语言自动检测：metaPromptLanguage: 'auto'（默认）按指令非空白字符中汉字 占比 ≥30% 选择中文/英文角色文档（纯函数 detectLanguage，含假名的日文等语言归 英文文档）；'中文'/'英文' 固定语言，/optimizer-language 可运行时固定或恢复 自动。检测结果在单次调用内传递（optimize/iterate 按各自输入检测，selfRefine 沿用本轮语言，重试诊断文案同语言），与 outputLanguage 独立。
• 所有注册（工具、systemPrompt 段落、自动优化钩子、命令）均为 effect 作用域， 插件卸载自动清理。
• 命令命名：本插件注册 /optimize 与 /auto-optimize（短命令，遵循生态惯例）。 若未来与其他插件冲突，改名需同步 client.js 调用、README 与钩子前缀默认值 （/optimize ），建议一次性原子变更。

License

MIT — 自由使用、修改与分发（含商业用途），详见 LICENSE 文件。