convex

Consolidate Convex development best practices into a comprehensive backend guide.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/Ermianr/fobos --skill convex-ermianr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex
Source: https://github.com/Ermianr/fobos/tree/main/skills/convex
Command: npx skills add https://github.com/Ermianr/fobos --skill convex-ermianr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill consolidates Convex development guidelines into a coherent reference, helping teams build robust, typed, and maintainable Convex backends.

Core Features & Use Cases

  • Function guidelines: Standardize function definitions using the new Convex function syntax, including proper argument and return validators.
  • Validators & Schemas: Enforce strict validators, schema definitions, and type-safety for IDs and records.
  • Api Design & Registration: Differentiate public vs internal functions and enforce safe usage patterns, with examples of queries, mutations, and actions.
  • Pagination, Storage & Scheduling: Cover paginated queries, file storage guidelines, and scheduling patterns for background tasks.
  • Guidelines Coverage: Includes TypeScript typings, code organization, and performance considerations for Convex apps.
  • Real-world usage examples: How to structure Convex projects with schema.ts, generated API references, and typical file layouts.

Quick Start

Read this guide to structure your Convex project: create convex/index.ts with query/mutation definitions, define convex/schema.ts, and align your project layout with the examples provided.

Frequently Asked Questions about convex

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I structure a Convex backend project with TypeScript?

Structure Convex backends by defining queries and mutations in convex/index.ts and establishing database tables in convex/schema.ts. This layout enforces strict TypeScript typings and maintainable code organization.

What is the best way to define validators and schemas in Convex?

Defining Convex validators and schemas requires enforcing strict type-safety for document IDs and records. Standardize argument and return validators using the new function syntax to guarantee safe, typed backend code.

How do I implement paginated queries and file storage in a Convex app?

Implement Convex paginated queries and file storage by applying prescribed patterns for data fetching and storage guidelines. This approach supports scalable data retrieval and efficient asset management in backend apps.

How do I differentiate public vs internal API functions in Convex?

Differentiate public vs internal Convex functions by enforcing safe usage patterns during API design and registration. This involves separating queries, mutations, and actions to control endpoint exposure and maintain security.

Does this guide cover scheduling background tasks in Convex?

Yes, Convex scheduling patterns for background tasks are covered. The guide provides conventions for scheduling jobs, ensuring background processes run safely and maintainably within your backend architecture.