SuperAPI AI 工具集

convex-docs

编程与开发

查看项目

更新于 11-11 17:59

技能介绍

convex-docs 是一个面向 Convex 开发的新鲜度层技能,用于在编写代码前获取与项目实际安装版本一致的文档事实。

用途 内置的 convex-expert 知识带有插件版本烙印,适合稳定惯用法,但在组件新增导出、CLI 参数变更、API 跨版本改名等地方容易过时。convex-docs 的作用是在这些场景下补充“当前版本”的事实,避免凭记忆写出与已安装版本不符的 API。

主要能力与工作流程

  1. 固定版本:读取已安装的 convex 版本(例如通过 node -p "require('./node_modules/convex/package.json').version" 或 package.json),并确认在用的 @convex-dev/* 组件版本。所信任的文档必须与这些版本匹配,版本偏差是错误 Convex 代码的最大来源。
  2. 按新鲜度层级获取信息(最省成本且正确优先): (a) 如有可用的文档服务工具或 MCP 的 search_convex_docs,优先使用,它返回按版本限定并重排过的答案; (b) 否则以 Markdown 形式抓取具体文档页,请求 docs.convex.dev/<path>,站点提供 .md/markdown 形式时优先使用,或读取对应固定版本的组件 README; (c) 最后才回退到通用网络搜索,并将其版本视为未经验证。 在新鲜度存疑时,不要跳过上述步骤直接凭记忆写 API。
  3. 必要时对照已安装包验证:对不确定是否存在的组件导出,检查 node_modules/@convex-dev/<x>/ 中的 package.json exports 和 .d.ts;已安装类型是该版本的事实依据,比任何文档页更具权威性。
  4. 窄范围使用获取到的事实:应用当前签名或参数,注明来源(页面与版本),再把实际代码交给 convex-expert 以惯用方式编写。convex-docs 提供新鲜事实,convex-expert 提供惯用法。
  5. 遇到版本不匹配的构建错误(某个“应该”存在的导出或参数实际不存在)时,将其视为新鲜度问题:重新固定版本、获取当前 API 并修正,而不是猜测另一种拼写。

使用方式 该技能以工作流规则的形式组织,通过读取版本、按层级抓取 Markdown 文档、核对 node_modules 类型来提供事实,再交由 convex-expert 编写代码。资料未提供具体安装命令或调用接口。

适用场景

  • 需要使用不熟悉或可能改名的 Convex 或组件 API;
  • 构建时报出版本不匹配、导出缺失或参数不存在;
  • 希望在保证版本一致的前提下以较少 token 获取文档。

限制 资料未说明收费、价格、支持平台或效果数据;文档抓取依赖站点提供 Markdown 形式,通用网络搜索结果被视为版本未经验证;该技能只提供事实层,不替代 convex-expert 的惯用代码知识。