playbooks

home / skills / waynesutton / convexskills / convex

convex skill

/skills/convex

This skill guides you through Convex development patterns, routing to specialized skills for efficient backend, data, and automation workflows.

npx playbooks add skill waynesutton/convexskills --skill convex

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
2.0 KB
---
name: convex
displayName: Convex Development
description: Umbrella skill for all Convex development patterns. Routes to specific skills like convex-functions, convex-realtime, convex-agents, etc.
version: 1.0.0
author: Convex
tags: [convex, backend, database, realtime]
---

# Convex Development Skills

This is an index skill for Convex development. Use specific skills for detailed guidance:

## Core Development

| Skill | Command | Use When |
|-------|---------|----------|
| Functions | `/convex-functions` | Writing queries, mutations, actions |
| Schema | `/convex-schema-validator` | Defining database schemas and validators |
| Realtime | `/convex-realtime` | Building reactive subscriptions |
| HTTP Actions | `/convex-http-actions` | Webhooks and HTTP endpoints |

## Data & Storage

| Skill | Command | Use When |
|-------|---------|----------|
| File Storage | `/convex-file-storage` | File uploads, serving, storage |
| Migrations | `/convex-migrations` | Schema evolution, data backfills |

## Advanced Patterns

| Skill | Command | Use When |
|-------|---------|----------|
| Agents | `/convex-agents` | Building AI agents with tools |
| Cron Jobs | `/convex-cron-jobs` | Scheduled background tasks |
| Components | `/convex-component-authoring` | Reusable Convex packages |

## Security

| Skill | Command | Use When |
|-------|---------|----------|
| Security Check | `/convex-security-check` | Quick security audit checklist |
| Security Audit | `/convex-security-audit` | Deep security review |

## Guidelines

| Skill | Command | Use When |
|-------|---------|----------|
| Best Practices | `/convex-best-practices` | General patterns and guidelines |

## Quick Start

For most tasks:
1. Start with `/convex-best-practices` for general patterns
2. Use `/convex-functions` for writing backend logic
3. Use `/convex-schema-validator` for data modeling
4. Use specific skills as needed for your use case

## Documentation

- Primary: https://docs.convex.dev
- LLM-optimized: https://docs.convex.dev/llms.txt

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.

FAQ

Which skill should I pick first for a new project?

Start with /convex-best-practices, then define your schema with /convex-schema-validator and implement backend logic via /convex-functions.

Where can I find official Convex docs?

Primary documentation is available at the Convex docs site; the index skill also links to LLM-optimized guidance for quick reads.