@ifrankwang/openspec-agents 0.149.0 → 0.149.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.mcp-server/cli.mjs +1 -1
- package/README.md +90 -59
- package/package.json +2 -2
- package/src/adapters/codex/index.ts +2 -2
- package/src/adapters/plugin-common/index.ts +1 -1
package/.mcp-server/cli.mjs
CHANGED
|
@@ -30575,7 +30575,7 @@ async function ensureDefaultUnattended(args, ctx) {
|
|
|
30575
30575
|
}
|
|
30576
30576
|
} catch {}
|
|
30577
30577
|
}
|
|
30578
|
-
var PKG_VERSION = "0.149.
|
|
30578
|
+
var PKG_VERSION = "0.149.1";
|
|
30579
30579
|
function buildMcpServer(worktree, opts = {}) {
|
|
30580
30580
|
const mcp = new McpServer({ name: "openspec-agents", version: PKG_VERSION });
|
|
30581
30581
|
for (const [name, spec] of Object.entries(TOOL_SPECS)) {
|
package/README.md
CHANGED
|
@@ -3,34 +3,49 @@
|
|
|
3
3
|

|
|
4
4
|

|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
`openspec-agents` 是 [OpenSpec](https://openspec.sh) 的配套插件,兼容 Claude Code / Codex / ZCode / DeepSeek Harness / OpenCode:提案阶段把标准钉得更死(澄清在前、改动范围与契约变更逐条确认),实施阶段由多 Agent 分工——写、查、验收、质量审查各由不同 Agent 担任,按生产级标准把控到收口。
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
前提:项目正在使用 OpenSpec 管理需求。
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
| | |
|
|
11
|
+
|---|---|
|
|
12
|
+
| 适合 | 变更需要真正落进代码库、有验收标准、需通过检查、过程可追溯的团队与项目 |
|
|
13
|
+
| 不适合 | 希望快速产出 demo、不走检查与验收的场景 |
|
|
14
|
+
| 代价 | 比单个 AI 直接修改更慢,Token 消耗更高 |
|
|
15
|
+
| 模型选型 | 实施用 flash 类模型,提案用旗舰模型 |
|
|
11
16
|
|
|
12
|
-
##
|
|
17
|
+
## 常见痛点
|
|
13
18
|
|
|
14
|
-
- AI
|
|
15
|
-
-
|
|
16
|
-
-
|
|
19
|
+
- AI 一次改一大片,改完声称「完成了」——能编译、测试也通过,但其中夹带的空实现与伪成功未被发现。
|
|
20
|
+
- 共用逻辑被改动后,其他调用入口仍在使用旧写法,无人察觉。
|
|
21
|
+
- 出了问题想复盘,只能翻到大量对话记录,看不出当时按什么标准放行。
|
|
17
22
|
|
|
18
|
-
##
|
|
23
|
+
## 与工具自带工作流的区别
|
|
19
24
|
|
|
20
|
-
Claude Code 和 DeepSeek Harness
|
|
25
|
+
Claude Code 和 DeepSeek Harness 自带的工作流能力擅长**并行完成大量独立任务**。这个插件解决的是另一件事,两者可以叠加使用。
|
|
21
26
|
|
|
22
27
|
| | 工具自带的工作流 | 本插件 |
|
|
23
28
|
|---|---|---|
|
|
24
|
-
| 擅长 |
|
|
25
|
-
|
|
|
26
|
-
|
|
|
27
|
-
| 中断之后 |
|
|
29
|
+
| 擅长 | 并行完成大量独立任务 | 单个变更按阶段推进,逐层把关 |
|
|
30
|
+
| 如何放行 | 由脚本中的判断决定 | 由程序强制:检查未完成、问题未闭环时无法以「通过」提交 |
|
|
31
|
+
| 跨工具 | 各家私有 | 同一套流程跨工具通用 |
|
|
32
|
+
| 中断之后 | 进度依附于对话或单次运行 | 进度记录在仓库中,换会话、换工具均可继续 |
|
|
33
|
+
|
|
34
|
+
一句话:原生工作流负责把任务做完,这个插件负责判定产出是否达到生产级。
|
|
35
|
+
|
|
36
|
+
## 局限
|
|
28
37
|
|
|
29
|
-
|
|
38
|
+
使用前请先确认以下三条边界。
|
|
30
39
|
|
|
31
|
-
|
|
40
|
+
**存量项目需要一次收敛成本。** 判据按理想状态定义(方法不超过 50 行、类职责单一、核心域不依赖框架、构建产物需忽略、覆盖率需达标),且工具检查覆盖全量代码——存量违规同样按原级别上报并阻塞。存量项目首次运行会暴露大量存量问题,只能逐个修复,或逐个走豁免裁定;裁定通过的会沉淀进项目级清单,后续变更不再重复阻塞。
|
|
32
41
|
|
|
33
|
-
|
|
42
|
+
**Java 之外只有通用规范。** 23 份 skill 中 10 份技术栈无关、11 份为 Java 后端配套(含具体构建与检查命令、ArchUnit 规则、Spotless / PMD / SonarQube 配置)。非 Java 项目审查照常执行,但编译、格式、静态分析、覆盖率这几项确定性检查没有现成命令,需自行补充一份技术栈 skill,否则只能按降级申报跳过。
|
|
43
|
+
|
|
44
|
+
**架构规范只有 DDD 一套。** 包组织有两种等价的合法风格——四层分层(domain / application / infrastructure / interfaces)与六边形(内核 + 入站 / 出站适配器),采用哪种由项目声明,未声明时按四层认定。不按 DDD 组织的项目(例如 MVC + Service + DAO 直写)没有对应规范,会被判定为偏离规范并报出问题;项目已有自己的架构规范时以项目规范为准,但该规范需自行写入。
|
|
45
|
+
|
|
46
|
+
## 快速开始
|
|
47
|
+
|
|
48
|
+
项目还没用 OpenSpec 的话,先装上并初始化:
|
|
34
49
|
|
|
35
50
|
```bash
|
|
36
51
|
npm install -g @fission-ai/openspec
|
|
@@ -91,22 +106,23 @@ npm install -D @ifrankwang/openspec-agents
|
|
|
91
106
|
|
|
92
107
|
首次加载时,插件会在项目 `.opencode/agents/` 下生成三个代理定义文件。这些文件带生成标记,插件**每次加载**都按当前版本重写;要自己改,先删掉文件里的生成标记。
|
|
93
108
|
|
|
94
|
-
###
|
|
109
|
+
### 第二步:确认安装成功
|
|
95
110
|
|
|
96
111
|
重启后查看可用 skill 列表:`openspec-standard`、`orchestrator` 是插件自带的两个入口,它们和一批规范类 skill 一起出现在列表里,就说明插件已经生效。这些 skill 可以像命令一样唤起(DSH 里输入 `/` 即可看到并调用)。
|
|
97
112
|
|
|
98
|
-
###
|
|
113
|
+
### 第三步:开始使用
|
|
99
114
|
|
|
100
115
|
- 项目里还没提变更时,调用 `/openspec-standard`,把提案标准装进项目。
|
|
101
|
-
-
|
|
116
|
+
- 提变更用 OpenSpec 官方命令:`/openspec-propose {具体需求描述}`,生成 `openspec/changes/<变更名>/` 下的文档;装过提案标准后,这些文档会按更严的标准产出。
|
|
117
|
+
- 然后调用 `/orchestrator {change-id}` 开始编排。`{change-id}` 就是那个目录名,`openspec list` 能看到当前有哪些变更。
|
|
102
118
|
|
|
103
119
|
> 不同工具里 skill 的呈现形式可能不同,以各工具实际显示为准。
|
|
104
120
|
|
|
105
|
-
###
|
|
121
|
+
### 默认无人值守
|
|
106
122
|
|
|
107
123
|
各安装方式**默认都开启无人值守**:流程里需要人拍板的环节(方案怎么选、无法自动验证的部分)由编排 AI 自行决断,不会停下来问你——**审查和门禁照常跑,变的只是「要不要来问你」**。希望它在这些地方先问你,让它关掉无人值守模式即可。
|
|
108
124
|
|
|
109
|
-
###
|
|
125
|
+
### 将以下两行加入 `.gitignore`
|
|
110
126
|
|
|
111
127
|
```
|
|
112
128
|
.worktree/
|
|
@@ -115,32 +131,6 @@ openspec/states/
|
|
|
115
131
|
|
|
116
132
|
两者都不该进版本库:前者是变更(以及独立审查)的独立工作副本,后者是流程进度。
|
|
117
133
|
|
|
118
|
-
## 它替你守住什么
|
|
119
|
-
|
|
120
|
-
- **分工协作**:不再是单个 AI 从头写到尾、写完自己说没问题。完整模式下,实现、检查、验收、质量审查是彼此分开的角色;精简模式把确定性检查交给开发者执行,再由一个审查者合并复核。
|
|
121
|
-
- **每一步都要过校验**:完整模式下,实现完先过工具检查,再走独立验收,最后过多个维度的质量审查,结论不通过就退回修复。流程规则由程序强制——检查没做完、问题没闭环,就不可能以「通过」提交;至于质量判断本身,仍由承担该环节的审查角色给出。
|
|
122
|
-
- **问题跟到底**:变更编排里,审查发现的问题会一直挂在变更上,要么修好,要么走豁免流程由报出该问题的审查者裁定通过,否则不允许继续推进。
|
|
123
|
-
- **写隔离**:变更在独立分支和独立工作副本里做,收口前你的基准分支上看不到这些改动。
|
|
124
|
-
- **中断能接上**:进度记在仓库里,问一句「现在跑到哪了」就能看到;关掉工具、隔一天、换个工具,都能从上次的位置继续。
|
|
125
|
-
- **规范驱动**:直接消费 OpenSpec 的提案、规格、设计、任务清单,流程与规范一一对应。
|
|
126
|
-
|
|
127
|
-
初始化编排时选流程模式,**默认是精简模式**:精简模式把确定性检查交给开发者执行、审查者分级复验,小改动不必走全套;完整模式开头多一道方案预检,验收也拆得更细。
|
|
128
|
-
|
|
129
|
-
## 内置的规范库
|
|
130
|
-
|
|
131
|
-
插件自带 23 份 skill(含两个流程入口),装了就有,不用自己写提示词;审查的 AI 会按当前任务需要自动挂上对应的一组。
|
|
132
|
-
|
|
133
|
-
**两个入口**
|
|
134
|
-
|
|
135
|
-
- `orchestrator` —— 编排准则,主代理按它分派子代理、推进流程。
|
|
136
|
-
- `openspec-standard` —— 提案标准初始化。
|
|
137
|
-
|
|
138
|
-
**10 份通用规范**:DDD 分层与六边形、REST 接口约定、数据库设计约定、安全审查基线、确定性质量门、测试设计、技术债识别、架构演进审查、API 自动化测试、隔离环境清理。
|
|
139
|
-
|
|
140
|
-
**11 份 Java 后端配套**:在通用规范之上补齐 Java / Spring 的实现细节 —— Lombok、日志与命名约定、REST 接口的 Java 实现、MyBatisPlus 与 Flyway、DDD 的 Java 实现与 ArchUnit 规则、Maven / Spotless / PMD / SonarQube 质量门、工具规则改进、Java 开发实践、Java 安全实现、Java 性能与可维护性、Java 技术债形态。
|
|
141
|
-
|
|
142
|
-
Java 后端项目会自动带上配套那套;其它语言目前只有通用规范生效,具体的构建与检查命令由你项目的规范补充。
|
|
143
|
-
|
|
144
134
|
## 提案标准化
|
|
145
135
|
|
|
146
136
|
OpenSpec 官方默认的流程是 `proposal → specs → design → tasks`,给出文档骨架与写作要求。这套标准在它前面加一道澄清与确认关,并把改动范围、契约变更、文档语言钉得更死。
|
|
@@ -157,10 +147,60 @@ OpenSpec 官方默认的流程是 `proposal → specs → design → tasks`,
|
|
|
157
147
|
| 任务划分 | 分组 + 每条带验证方式 | 追加:每组必须有真实代码改动(禁止「收尾组」凑数)、测试跟着实现同组、只覆盖本仓库 |
|
|
158
148
|
| 归档 | 官方归档命令本身会同步主规格 | 追加写作纪律:主规格只写终态,不留「原 X 改为 Y」;废弃项显式删除并补 REMOVED;同语义合并去重 |
|
|
159
149
|
|
|
160
|
-
|
|
150
|
+
**用法**:在目标项目的普通会话里调用 `/openspec-standard`(不要在被编排流程占用的会话里调用,那种会话不能改文件)。它会往项目写入 `openspec/config.yaml`(指定 `spec-driven-standard` schema)与 `openspec/schemas/spec-driven-standard/`。
|
|
151
|
+
|
|
152
|
+
装好之后提变更不必换命令,仍走 OpenSpec 官方用法:调用 `/openspec-propose {具体需求描述}`,生成的 proposal / specs / design / tasks 就会按这套标准产出,再由 `/orchestrator {change-id}` 接手实施与把关。
|
|
161
153
|
|
|
162
154
|
已经装过标准的项目重跑就是升级:标准更新到插件当前版本,你自己加的规则条目和项目背景会保留。
|
|
163
155
|
|
|
156
|
+
## 质量把关机制
|
|
157
|
+
|
|
158
|
+
「生产级」不是靠提示词要求的,而是逐层校验出来的。
|
|
159
|
+
|
|
160
|
+
**审查分工**
|
|
161
|
+
|
|
162
|
+
```
|
|
163
|
+
完整模式 方案预检 → 实现 → 工具检查 → 独立验收 → 五维质量审查 → 收口
|
|
164
|
+
精简模式 实现 → 合并审查 → 收口
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
最终判定不由实现者自己作出。完整模式下,检查、验收、质量审查由彼此独立的角色承担;精简模式由开发者执行确定性检查,再由一名审查者独立复核。
|
|
168
|
+
|
|
169
|
+
**工具与 AI 的分工**
|
|
170
|
+
|
|
171
|
+
确定性检查全部交给工具执行:编译、代码格式、架构约束、静态分析、单元测试与覆盖率、深度扫描,以及质量工具配置有没有被弱化。AI 审查只负责工具覆盖不到的部分——业务行为是否真实生效、关键数据是否真的落库、测试断言有没有放水、设计与规则边界是否站得住,并把其中可工具化的发现反过来沉淀成规则。判据锚在 skill 上,不是让模型现场发挥,所以非旗舰模型(flash 类)的产出下限同样有保障。
|
|
172
|
+
|
|
173
|
+
**通过标准**
|
|
174
|
+
|
|
175
|
+
- **五级定级**:Critical / High / Medium / Low / Info,各级判例锚定规范 skill;Info 仅为建议,Low 及以上未修复不得推进。
|
|
176
|
+
- **问题闭环**:审查报出的问题挂在变更上,修复后由报出该问题的审查者复核通过方为终结;确实无法修复的提交豁免申请,由同一审查者裁定,被驳回则退回重修。
|
|
177
|
+
- **程序强制**:检查未完成、问题未闭环时,无法以「通过」提交——由工具拦截,而非依赖提示词约束。
|
|
178
|
+
- **禁止规避**:压制注解、关闭规则、修改扫描平台状态一律视为豁免申请,须写明理由并接受裁定;同一问题修复未过两次,须先完成根因分析再修改。
|
|
179
|
+
- **规则沉淀**:可由工具检出的问题,要求同时提交业务问题与规则草案,将本次判定口径沉淀为后续的自动拦截规则。
|
|
180
|
+
|
|
181
|
+
**其他特性**
|
|
182
|
+
|
|
183
|
+
- **变更隔离**:变更在独立分支与独立工作副本中进行,收口前基准分支上看不到这些改动。
|
|
184
|
+
- **可续跑**:进度记录在仓库中,查询当前状态即可恢复;关闭工具、跨天、更换工具都能从上次位置继续。
|
|
185
|
+
- **规范驱动**:直接消费 OpenSpec 的提案、规格、设计与任务清单,流程与规范一一对应。
|
|
186
|
+
|
|
187
|
+
初始化编排时选择流程模式,**默认为精简模式**:精简模式下小改动不必走全套流程;完整模式在开头增加一道方案预检,验收也拆得更细。
|
|
188
|
+
|
|
189
|
+
## 内置的规范库
|
|
190
|
+
|
|
191
|
+
插件自带 23 份 skill(含两个流程入口),安装后即可使用,无需自行编写提示词;审查 AI 会按当前任务自动加载对应的一组,作为判据的**最低基准**——审查者还需结合自身领域知识扩展覆盖,不限于清单所列条目。
|
|
192
|
+
|
|
193
|
+
**两个入口**
|
|
194
|
+
|
|
195
|
+
- `orchestrator` —— 编排准则,主代理按它分派子代理、推进流程。
|
|
196
|
+
- `openspec-standard` —— 提案标准初始化。
|
|
197
|
+
|
|
198
|
+
**10 份通用规范**:DDD 分层与六边形、REST 接口约定、数据库设计约定、安全审查基线、确定性质量门、测试设计、技术债识别、架构演进审查、API 自动化测试、隔离环境清理。
|
|
199
|
+
|
|
200
|
+
**11 份 Java 后端配套**:在通用规范之上补齐 Java / Spring 的实现细节 —— Lombok、日志与命名约定、REST 接口的 Java 实现、MyBatisPlus 与 Flyway、DDD 的 Java 实现与 ArchUnit 规则、Maven / Spotless / PMD / SonarQube 质量门、工具规则改进、Java 开发实践、Java 安全实现、Java 性能与可维护性、Java 技术债形态。
|
|
201
|
+
|
|
202
|
+
Java 后端项目会自动带上配套那套;其它语言目前只有通用规范生效,具体的构建与检查命令由你项目的规范补充。
|
|
203
|
+
|
|
164
204
|
## 独立审查会话
|
|
165
205
|
|
|
166
206
|
除了绑定变更的编排,插件也支持不绑定任何变更的独立代码审查:对一个 PR 的改动区间、或整个代码库做一次完整审查。
|
|
@@ -173,7 +213,7 @@ OpenSpec 官方默认的流程是 `proposal → specs → design → tasks`,
|
|
|
173
213
|
|
|
174
214
|
审查在独立工作副本里进行。`fix` 模式全部通过后把工作分支合并回目标分支并清理环境;`none` 模式不合并,直接销毁工作环境并按严重级别、维度、文件位置归并给出审查结果。
|
|
175
215
|
|
|
176
|
-
##
|
|
216
|
+
## 对仓库的写入范围
|
|
177
217
|
|
|
178
218
|
编排流程只碰这几处,全在你的仓库内:
|
|
179
219
|
|
|
@@ -185,16 +225,7 @@ OpenSpec 官方默认的流程是 `proposal → specs → design → tasks`,
|
|
|
185
225
|
|
|
186
226
|
变更的全部任务组完成后,才会把这条分支合并回基准分支,随后自动删掉工作副本和分支。合并前如果基准分支已经往前走了,插件先比对两边改动:只有文档、规划文件或版本号这类无害变化时直接合并;有实质冲突时退回做一次收尾回归,通过后才合并。
|
|
187
227
|
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
## 适用场景与代价
|
|
191
|
-
|
|
192
|
-
| | |
|
|
193
|
-
|---|---|
|
|
194
|
-
| 适合 | 一个变更要真正落进代码库、有验收标准、要过几道检查、过程要能审计,可能跨天甚至跨工具的团队与项目 |
|
|
195
|
-
| 代价 | 比单个 AI 直接改更慢,Token 消耗更高 |
|
|
196
|
-
|
|
197
|
-
如果你愿意用一点成本换取稳定、可复现、可审计的实施过程,这个项目就是为你准备的。
|
|
228
|
+
**中途放弃**:删除工作副本与 `change/<变更号>` 分支即可,基准分支不会留下该变更的任何代码。
|
|
198
229
|
|
|
199
230
|
## 开发
|
|
200
231
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ifrankwang/openspec-agents",
|
|
3
|
-
"version": "0.149.
|
|
4
|
-
"description": "OpenSpec
|
|
3
|
+
"version": "0.149.1",
|
|
4
|
+
"description": "OpenSpec companion plugin for AI coding agents (Claude Code, Codex, ZCode, DeepSeek Harness, OpenCode): a stricter proposal standard plus multi-agent implementation and review, gated to production-grade standards",
|
|
5
5
|
"author": "ifrankwang",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"homepage": "https://github.com/ifrankwang/openspec-agents#readme",
|
|
@@ -118,12 +118,12 @@ export function buildCodexPlugin(outDir: string = CODEX_PLUGIN_DIR): PluginPacka
|
|
|
118
118
|
mcpServers: "./.mcp.json",
|
|
119
119
|
interface: {
|
|
120
120
|
displayName: "OpenSpec Agents",
|
|
121
|
-
shortDescription: "OpenSpec
|
|
121
|
+
shortDescription: "Production-grade OpenSpec proposals, implementation and review for Codex",
|
|
122
122
|
longDescription: PLUGIN_DESCRIPTION,
|
|
123
123
|
developerName: "ifrankwang",
|
|
124
124
|
category: "Developer Tools",
|
|
125
125
|
capabilities: ["Read", "Write"],
|
|
126
|
-
defaultPrompt: ["Run the OpenSpec
|
|
126
|
+
defaultPrompt: ["Run the OpenSpec proposal, implementation and review workflow."],
|
|
127
127
|
},
|
|
128
128
|
},
|
|
129
129
|
null,
|
|
@@ -18,7 +18,7 @@ import { parseAgentMd, resolve, EXCLUDED_AGENTS } from "../agent-md.ts"
|
|
|
18
18
|
|
|
19
19
|
export const PLUGIN_NAME = "openspec-agents"
|
|
20
20
|
export const PLUGIN_DESCRIPTION =
|
|
21
|
-
"OpenSpec
|
|
21
|
+
"OpenSpec companion plugin for AI coding agents: a stricter proposal standard plus multi-agent implementation and review, gated to production-grade standards."
|
|
22
22
|
/** plugin.json author(各插件包统一署名项目作者)。 */
|
|
23
23
|
export const PLUGIN_AUTHOR = "ifrankwang"
|
|
24
24
|
|