用途
convex-docs 用于解决 Convex 开发中「知识过期」的问题。内置的 convex-expert 提供的是随插件版本固化的知识,适合稳定的惯用写法,但在组件新增导出、CLI 参数变更、API 在版本间改名等情况下会失效。convex-docs 作为叠加在其上的时效性纪律,确保写下的代码基于项目真实使用的版本,而不是记忆中的旧版 API。
主要能力
- 版本固定:读取项目实际安装的 convex 版本,以及正在使用的 @convex-dev/* 组件版本,使参考的文档与这些版本一致。
- 按层级获取最新资料(成本最低且正确者优先):
- 如果可用已提供的文档工具或 MCP 搜索(search_convex_docs),优先使用,它返回按版本限定并重排过的答案,体量适配上下文窗口;
- 否则抓取指定文档页面,并以 Markdown 形式获取(站点提供 .md/markdown 形式时优先),比 HTML 消耗的 token 少得多,或读取指定版本组件的 README;
- 最后才退回通用网页搜索,并将其版本视为未经验证。
- 验证:对不确定是否存在的组件导出,检查 node_modules 中已安装包的 package.json exports 与 .d.ts,已安装类型是该版本的事实依据,比任何文档页更具权威性。
- 有限使用:只取用当前签名或参数,标明来源(页面与版本),把实际代码交回 convex-expert 以符合惯用写法。
使用方式
工作流分四步:PIN(固定版本,例如通过读取 node_modules/convex/package.json 的 version 字段或 package.json)、按新鲜度层级获取(文档工具/MCP → Markdown 页面或固定版本 README → 通用搜索)、必要时对照安装包验证、最后把新鲜事实交给 convex-expert 编写惯用代码。
适用场景
- 使用 Convex 或 @convex-dev/* 组件进行开发,需要确认某个 API、导出或 CLI 参数在当前版本中是否存在。
- 出现「本应存在却不存在」的导出/参数构建报错,需要按版本重新核对当前 API。
- 在时效性存疑时,避免凭模型记忆书写不熟悉或可能已改名的 API。
限制
- 该技能是时效性补充层,不替代 convex-expert 的固有能力。
- 仅依据来源层级获取事实,不负责编写惯用代码。
- 具体支持的版本范围、依赖条件、收费与价格等信息暂未提供。