convex-rules

Document Convex endpoint safety and best practices for validators, function types, and access controls.

1|3|Updated Mar 15, 2026
One-click install
npx skills add https://github.com/Notava1ble/mscl-website --skill convex-rules
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-rules
Source: https://github.com/Notava1ble/mscl-website/tree/main/.agents/skills/convex
Command: npx skills add https://github.com/Notava1ble/mscl-website --skill convex-rules

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Rules and best practices for building Convex-based backends with robust data models, safe function registration, and secure APIs.

Core Features & Use Cases

  • Guidance on function types: queries, mutations, actions, internal vs public
  • Guidance on data modeling, pagination, authentication, storage guidelines, and file structure
  • Practical patterns for endpoint routing, validators, and error handling

Quick Start

Define your Convex schema, implement public and internal functions with validators, and follow the documented patterns to ensure secure, scalable endpoints.

Frequently Asked Questions about convex-rules

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

FAQPage Schema
How do I secure Convex endpoints with authentication and access controls?

Securing Convex endpoints requires defining strict access controls for public and internal functions. You configure authentication validators within your function types to ensure only authorized users execute specific queries, mutations, or actions.

What is the best way to structure data models and validators in Convex?

The best way to structure Convex data models is by defining strict schema validators for your tables. This ensures robust data validation and safe function registration, preventing invalid data from entering your backend storage.

Can I use internal functions for scheduling tasks in a Convex backend?

Yes, you can use internal functions for scheduling tasks in a Convex backend. Internal functions provide a safe way to handle server-side scheduling without exposing the endpoints publicly, ensuring secure asynchronous operations.

How do I implement pagination in Convex queries safely?

Implementing pagination in Convex queries safely involves applying specific validators to your query endpoints. Following documented server-side rules ensures your data retrieval remains scalable and secure across large datasets.

When do I need to separate public vs internal function types in Convex?

You need to separate public and internal Convex function types when building secure APIs. Public functions handle client requests, while internal functions manage server-side operations like scheduling, limiting exposure to your backend.

Does this guide cover error handling and file structure for Convex backends?

Yes, this guide covers practical patterns for error handling and file structure within Convex backends. It defines strict YAML structures and code guidelines to ensure your repository remains organized and safe.