SuperAPI AI 工具集

convex-docs

通用与其它

查看项目

更新于 10-16 03:06

技能介绍

用途:为 Convex 项目提供“版本对齐”的文档新鲜度纪律。convex-expert 自带固化的插件版本知识,适合稳定惯用法,但对新增导出、变更的 CLI 标志或版本间改名的 API 容易过时;本技能在其之上补充实时核对环节。

主要能力:一是锁定版本,通过 node -p "require('./node_modules/convex/package.json').version" 或 package.json 读取已安装的 convex 版本,以及涉及的 @convex-dev/* 组件版本,信任的文档必须与这些版本一致,版本错位是错误 Convex 代码的最大来源。二是按“最省且正确优先”的新鲜度层级获取信息:(a) 若有已服务化的文档工具或 MCP 的 search_convex_docs,优先使用,它返回按版本限定并重排的结果;(b) 否则抓取具体文档页的 Markdown 形式,请求 docs.convex.dev/<path> 并优先 .md 形式,或取固定版本的组件 README,比 HTML 省大量 token;(c) 最后才退回到通用网页搜索,并将其版本视为未验证。三是在关键处用已安装包验证:对不确定是否存在的组件导出,检查 node_modules/@convex-dev/<x>/ 中的 package.json exports 与 .d.ts,已安装类型是当前版本的最终依据。

使用方式:将抓取到的事实窄范围使用,套用当前签名与标志,注明来源(页面与版本),再把实际代码交回 convex-expert 以惯用写法编写。遇到“本应存在却不存在”的导出或标志导致版本不匹配的构建错误时,应视为新鲜度问题:重新锁定版本、抓取当前 API 并修正,而非猜测别的拼写。

限制:本技能是新鲜度层,不替代固化知识;禁止在存疑时凭模型记忆编写不熟悉或可能改名的 Convex/组件 API;文档页优先 Markdown 而非 HTML;node_modules 中的导出与 .d.ts 比任何文档页更具权威性。原文未提供具体价格、平台支持范围或更多实现细节。