convex_skill

Overview

This skill is an umbrella index for Convex development patterns that routes you to focused skills like functions, realtime, agents, and migrations. It helps developers find the right Convex templates, patterns, and guidance for building production-ready JavaScript backends and AI-enabled apps. Use it as the starting point to locate targeted instructions and examples for common Convex tasks.

How this skill works

The skill maps high-level development needs to specialized sub-skills (e.g., functions, schema validators, realtime subscriptions, cron jobs). Ask or invoke the specific sub-skill command to get detailed examples, code snippets, and best practices for that area. It links to core Convex documentation and LLM-optimized guidance to accelerate implementation.

When to use it

• You need to find the right Convex pattern quickly (queries, mutations, cron, webhooks).
• You want a curated path for building AI agents, realtime apps, or scheduled jobs on Convex.
• You need guidance on data modeling, migrations, or file storage with Convex.
• You want security checklists or audit pointers tailored to Convex projects.
• You are starting a new Convex project and need a practical quick-start sequence.

Best practices

• Start with the best-practices skill to align project structure before writing code.
• Use functions for backend logic and schema validators for data integrity.
• Prefer realtime subscriptions for UI that needs live updates, and actions for long-running work.
• Keep migrations and backfills isolated and tested; use cron jobs for scheduled tasks.
• Leverage the agents skill when integrating LLMs or tool-based workflows to encapsulate prompts and tool calls.

Example use cases

• Implement a server-side mutation and corresponding realtime subscription for collaborative edits using /convex-functions and /convex-realtime.
• Set up file uploads and serving with /convex-file-storage while enforcing validators from /convex-schema-validator.
• Create an AI agent that uses Convex as memory and tools via /convex-agents and integrate scheduling with /convex-cron-jobs.
• Run a schema evolution and data backfill sequence with /convex-migrations after changing validators.
• Perform a security checklist or deep audit before production rollout using /convex-security-check or /convex-security-audit.