Agent Skills › ajanraj/OpenChat › convex-expert

convex-expert

GitHub

Convex后端专家技能,指导在convex/目录下进行函数、Schema及查询的开发。涵盖对象形式语法、验证器模式、索引优化、内部与公共API权限管理及组件集成,确保代码符合部署规范并避免常见性能陷阱。

.agents/skills/convex-expert/SKILL.md ajanraj/OpenChat

触发场景

用户需要编写或修改convex目录下的代码 涉及Convex数据库Schema定义或变更 需要创建或优化Convex查询和突变函数 配置Convex文件存储或认证逻辑

安装

npx skills add ajanraj/OpenChat --skill convex-expert -g -y
更多选项

非标准路径

npx skills add https://github.com/ajanraj/OpenChat/tree/main/.agents/skills/convex-expert -g -y

不安装直接使用

npx skills use ajanraj/OpenChat@convex-expert

指定 Agent (Claude Code)

npx skills add ajanraj/OpenChat --skill convex-expert -a claude-code -g -y

安装 repo 全部 skill

npx skills add ajanraj/OpenChat --all -g -y

预览 repo 内 skill

npx skills add ajanraj/OpenChat --list

SKILL.md

Frontmatter
{
    "name": "convex-expert",
    "description": "Convex backend specialist. Use this agent for any code inside a `convex\/` directory — function definitions, schemas, indexes, queries, mutations, actions, HTTP endpoints, cron jobs, file storage, auth wiring, and component installation. Knows the object-form function syntax, validator patterns, resource limits, and component ecosystem that generic Claude routinely gets wrong."
}

Convex backend specialist

Always-on Convex backend specialist invoked before touching any code inside a convex/ directory. Knows the object-form function syntax, validator requirements, index naming rules, internal-vs-public discipline, schema evolution patterns, resource limits, component ecosystem, and runtime error decoder that generic models routinely get wrong.

Workflow

  1. When about to write or edit any file under convex/: read convex/schema.ts first (and convex/_generated/ai/guidelines.md if present).
  2. Write all Convex functions in object form with both args and returns validators on every registered function.
  3. Use withIndex(...) for every read path — never .filter() for anything that would be a SQL WHERE clause.
  4. Default to internalQuery/internalMutation/internalAction; promote to public only when a client hook needs it.
  5. For any LLM/chat feature reach for @convex-dev/agent; for multi-step flows use @convex-dev/workflow — never hand-roll these.
  6. After writing, confirm convex dev pushed cleanly and fix any Schema/Returns/Argument validation errors in place.

Rules

  • DATA ACCESS + IMPORTS — read before writing any convex/*.ts (front-loaded, not a post-hoc lint):
  • Never an unbounded .collect() on a table that can grow — use .withIndex(...) and .paginate(paginationOptsValidator)/.take(n) instead. This is the single most common Convex deploy-blocking and perf defect.
  • Index, don't filter — add .index(...) in schema.ts for every read path and query it with .withIndex(...); .filter() is a full table scan, never a substitute for a WHERE.
  • The exact import table — get this wrong and the app fails to deploy: query/mutation/action/internalQuery/internalMutation/internalAction come from "./_generated/server"; api/internal come from "./_generated/api"; NEVER import { query } from "convex/server" or import { internal } from "./_generated/server" in application code — both are hard deploy failures.
  • v.literal("exact value") for a fixed string/enum member (e.g. v.union(v.literal("open"), v.literal("closed"))) — not a bare v.string() when the set of values is fixed.
  • "use node"; goes only at the top of action-only modules — a file with "use node" can never also export a query or mutation (they don't run in the Node runtime); split the file if you need both.
  • Object form only — never the legacy positional query(args, handler) syntax.
  • args and returns validators on every registered function, no exceptions.
  • v.id(tableName) for IDs, never v.string(); undefined is not a Convex value (use null).
  • Never add a required field to a populated table — add v.optional(...) first, backfill, then tighten.
  • Never include _creationTime as a column in a custom index (reserved; causes IndexNameReserved error).
  • Never store storage URLs in tables — store the Id<'_storage'> and call ctx.storage.getUrl(id) on read.
  • Mutations cannot fetch — all external IO goes in actions; persist via ctx.runMutation(internal.x.y).
  • Don't add a parallel database, cache, real-time service, API server, job queue, or object store — Convex is the backend.
  • Convex functions only run from the convex/ directory — never write schema.ts/queries/mutations/actions at the project root.
  • SELF-VERIFY RULE — before declaring backend work done, verify it compiles and pushes: run npx tsc --noEmit and push it to a deployment. Prefer the project's existing one; otherwise npx convex dev --once when npx convex whoami succeeds, and CONVEX_AGENT_MODE=anonymous npx convex dev --once ONLY when it does not. Forcing anonymous on a signed-in user rebinds .env.local and costs them the persistent, publishable cloud deployment they expect. Fix every error it reports before finishing — one verify round catches the wrong-relative-import / duplicate-symbol / unbalanced-paren class that otherwise breaks the deploy.

版本历史

  • 55de5cd 当前 2026-10-19 22:53

同 Skill 集合

.agents/skills/convex-add/SKILL.md
.agents/skills/convex-advisor/SKILL.md
.agents/skills/convex-agent/SKILL.md
.agents/skills/convex-auth/SKILL.md
.agents/skills/convex-authz/SKILL.md
.agents/skills/convex-backup/SKILL.md
.agents/skills/convex-billing/SKILL.md
.agents/skills/convex-cost/SKILL.md
.agents/skills/convex-create-component/SKILL.md
.agents/skills/convex-crons/SKILL.md
.agents/skills/convex-deploy-guard/SKILL.md
.agents/skills/convex-design/SKILL.md
.agents/skills/convex-docs/SKILL.md
.agents/skills/convex-domains/SKILL.md
.agents/skills/convex-env/SKILL.md
.agents/skills/convex-explain-app/SKILL.md
.agents/skills/convex-insights/SKILL.md
.agents/skills/convex-launch-readiness/SKILL.md
.agents/skills/convex-migrate-rehearse/SKILL.md
.agents/skills/convex-migrate/SKILL.md
.agents/skills/convex-migration-helper/SKILL.md
.agents/skills/convex-monitor/SKILL.md
.agents/skills/convex-optimize/SKILL.md
.agents/skills/convex-performance-audit/SKILL.md
.agents/skills/convex-quickstart/SKILL.md
.agents/skills/convex-reviewer/SKILL.md
.agents/skills/convex-self-heal/SKILL.md
.agents/skills/convex-sentinel/SKILL.md
.agents/skills/convex-setup-auth/SKILL.md
.agents/skills/convex-suggest/SKILL.md
.agents/skills/convex-test/SKILL.md
.agents/skills/convex-verify/SKILL.md
.agents/skills/convex-seed/SKILL.md
.agents/skills/convex/SKILL.md

元信息

文件数
0
版本
55de5cd
Hash
dd1023f4
收录时间
2026-10-19 22:53

首页 - Wiki
Copyright © 2011-2026 iteam. Current version is 2.156.0. UTC+08:00, 2026-11-21 16:17
浙ICP备14020137号-1