convex-guidelines

Provide Convex backend guidelines for functions, schemas, and TypeScript patterns.

Updated Feb 4, 2026
One-click install
npx skills add https://github.com/FabioFiorita/tastik --skill convex-guidelines
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-guidelines
Source: https://github.com/FabioFiorita/tastik/tree/main/.agents/skills/convex-guidelines
Command: npx skills add https://github.com/FabioFiorita/tastik --skill convex-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Convex developers need a concise, authoritative guide to building robust backend components. This Guidelines skill consolidates function syntax, validators, queries, mutations, actions, schema design, TypeScript patterns, pagination, and file storage into a single reference to improve consistency and quality.

Core Features & Use Cases

  • Coverage of function definition syntax, internal vs public registrations, and safe patterns for queries and mutations.
  • Guidance on schema design, indexing, and search stores, plus practical usage examples in Convex projects.
  • Use Case: A backend team standardizes Convex server-side code across a feature via this guideline to ensure correctness and maintainability.

Quick Start

Consult the Convex guidelines before starting a new backend task to ensure correct function patterns and schema usage.

Frequently Asked Questions about convex-guidelines

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

FAQPage Schema
What are the best practices for defining Convex queries and mutations in TypeScript?

Convex guidelines recommend using strict TypeScript patterns and validators for queries and mutations to ensure type safety. Registering functions as internal or public correctly manages access and maintains code safety across your backend.

How do I design schemas and configure indexing in Convex?

Define schemas in Convex using built-in validators to enforce document structure. Configure indexing on frequently queried fields to optimize read performance and enable efficient search stores across your database tables.

Does this guide cover scheduling actions and file storage in Convex?

Yes, the Convex guidelines cover scheduling, file storage, and pagination. These structured patterns help you manage background jobs and handle file uploads systematically within your backend architecture.

How do I standardize backend code organization across a Convex project?

Standardize Convex backend code by applying consistent function definition syntax and separating internal vs public registrations. This ensures correctness and maintainability across queries, mutations, and actions for your team.

When should I use validators in Convex functions?

Use validators in Convex functions whenever defining arguments or document schemas to enforce runtime type checking. They prevent invalid data from entering mutations or queries and ensure structural consistency.