SuperAPI AI 工具集

convex

编程与开发

查看项目

更新于 10-15 23:43

技能介绍

用途:面向 Convex 后端开发的指导性技能,覆盖查询、变更、动作、schema、验证器、认证、组件、智能体、搜索、测试、生产配置及客户端/服务端集成等主题。

主要能力:按任务主题组织本地参考指南,涵盖函数编写、验证器、schema 与索引、TypeScript 类型、查询、变更、动作、定时任务、文件存储、全文搜索、迁移、认证、组件、AI 与智能体、向量搜索、测试、生产配置以及客户端集成(React、React Native、Next.js、TanStack Start、Bun、Node.js、Python、Swift、Kotlin、OpenAPI 等)。

核心约定:每个文件优先导出一个 Convex 函数,除非现有代码库另有模式,同一文件内的小型私有辅助函数可以保留;在需要提升安全性、生成 API 类型、OpenAPI 输出或静态代码生成时使用精确验证器,但参数或返回值验证器并非强制,省略时回退到 v.any();v.any() 仅用于真正动态的载荷或可信外部 webhook,不作为普通应用数据的默认选择;需刻意选择运行时,查询与变更围绕 ctx.db 保持事务性,动作用于外部 I/O 与仅 Node 的工作,向量搜索仅限动作;优先使用索引与合理的 schema 设计,而非大范围过滤。

使用方式:优先查阅本地参考指南;若任务涉及尚未镜像到 references/ 的较新平台能力,先查阅 https://docs.convex.dev/llms-full.txt 再作改动。各指南标明阅读时机,例如编写或修改函数、定义验证器、修改 convex/schema.ts、编写查询或变更、编写调用外部 API 的动作、配置定时任务、处理文件存储、实现 withSearchIndex 搜索、规划迁移、配置认证、使用组件、处理 Convex Agent 与工作流、定义向量索引、添加后端测试、编辑 convex.json 与环境变量及部署配置、接入各类客户端。

限制:验证器为推荐而非普遍强制;涉及公开 API 形态、生成客户端、OpenAPI 输出或静态代码生成时应优先显式验证器;内部且载荷有意宽松时可局部使用 v.any(),但需通过命名与类型明确信任边界;高级搜索需尽早区分全文搜索与向量搜索,因其 schema、索引与函数类型不同;前端集成需选择对应框架的客户端文档,不要默认套用 React;部署或 AI 工具相关需先查 convex.json 与 CLI 文档。本资料未提供具体收费、价格或平台细节。