rrrrrredy/research-toolkit / plugins/research-toolkit
research-toolkit
FlaggedUse for source-backed long-form research and writing in English or Chinese across fields, including revisions and continuation. Understand requirements, develop analysis through substantive research collaboration, and deliver a complete report after independent review, audit and acceptance.
docs/compatibility.zh-CN.md
View on GitHub# 版本与兼容性约定
[English](compatibility.md) | [简体中文](compatibility.zh-CN.md)
## 当前审阅契约
新全稿任务使用审阅契约 3。三个独立评审组覆盖七项视角,按实际需要加领域专审,审计和最终复查各自独立。交付绑定当前报告与通过的独立复查结果。已保存的契约 2 计划沿用原有任务分配和完成规则。
## v2 完成契约
v2 保留了统一研究入口和现有 Skill、CLI、MCP、插件形态。当时的完成契约要求基础内容视角分别独立审阅,再完成独立审计和最终验收。已保存的 v2 计划不能用作者自评或合并视角的结果替代。这改变了早期的完成规则,因此使用主版本升级。
复用已有公开操作名称、来源、主张、要求与成果格式,Agent 工具原生任务和交接扩展这些操作。继续支持 Python 3.10+、`research-toolkit` Skill 名称和软件包入口。
## 接续已有工作
继续研究前保留任务目录、原报告、评审回复、输入快照和回执。通过 `status` 读取当前工作,复用来源、分析、稳定编号和仍有效要求。旧完成稿保持原样,接续稿另存。
未修改的历史完成记录按已记录的契约查看。为新交付继续研究时,使用适用的审阅计划,补齐独立角色和仍缺失的实质工作。不为复制记录重建任务,不将作者检查重新标成独立审阅,不补造未发生的执行。
各接入方式共用同一个研究入口。启动任务和读取指导时,去掉旧 CLI 的 `--profile` 或 JSON/MCP 的 `profile` 参数。已保存的来源、主张、要求和稿件记录仍可读取。旧作者清单作为原始文件保留,不再有专用完成执行路径,也不能认可新的交付。查看当时的完成行为使用对应历史版本。继续当前研究时,完成独立审阅、审计和最终复查。
## 公开兼容边界
文档记载的 CLI/MCP 操作名称、参数、返回字段及退出含义属于公开接口。可新增可选字段,客户端应容忍不认识的可选返回字段。删除受支持入口、改变字段类型或含义、收紧已经承诺的完成契约,均属不兼容变化。
内部辅助函数和诊断文案可以调整。工程修复可以拒绝文档契约原本不允许的输入。输入变化仍按来源和版本关联处理;只更新安装版本不会改写已完成研究或自动重跑历史对照。
## 版本号与更新
采用[语义化版本](https://semver.org/lang/zh-CN/):
| 类型 | 用途 |
| --- | --- |
| 补丁,如 `2.0.1` | 兼容的问题修复、说明澄清和打包修正。 |
| 次版本,如 `2.1.0` | 兼容的新增能力。 |
| 主版本,如 `2.0.0` | 公开兼容承诺变化,同时说明受影响行为与接续方式。 |
更新完整安装包并保留任务数据。发布时根目录 `VERSION`、插件清单、打包版本及中英文发布材料一致。标签和历史评测记录保持原身份,数据集仓库使用各自的版本序列。
原 1.x 兼容基线始于 1.0.0,保留了 v0.2.7 的任务行为。既有 1.x 版本仍可从原标签取得;本页不改变这些历史运行实际发生的事情。
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |