🇺🇸English

Convex Backend Guidelines

When to Load

• Trigger : Convex-specific development, writing Convex functions, schemas, queries, mutations, actions, or real-time subscriptions
• Skip : Project does not use Convex as its backend

Comprehensive guide for building Convex backends with TypeScript. Covers function syntax, validators, schemas, queries, mutations, actions, scheduling, and file storage.

When to Apply

Reference these guidelines when:

• Writing new Convex functions (queries, mutations, actions)
• Defining database schemas and validators
• Implementing real-time data fetching
• Setting up cron jobs or scheduled functions
• Working with file storage
• Designing API structure

Rule Categories

Quick Reference

Function Registration

// Public functions (exposed to clients)
import { query, mutation, action } from "./_generated/server";

// Internal functions (only callable from other Convex functions)
import {
  internalQuery,
  internalMutation,
  internalAction,
} from "./_generated/server";

Function Syntax (Always Use This)

export const myFunction = query({
  args: { name: v.string() },
  returns: v.string(),
  handler: async (ctx, args) => {
    return "Hello " + args.name;
  },
});

Common Validators

Function References

// Public functions
import { api } from "./_generated/api";
api.example.myQuery; // convex/example.ts → myQuery

// Internal functions
import { internal } from "./_generated/api";
internal.example.myInternalMutation;

Query with Index

// Schema
messages: defineTable({...}).index("by_channel", ["channelId"])

// Query
await ctx.db
  .query("messages")
  .withIndex("by_channel", (q) => q.eq("channelId", channelId))
  .order("desc")
  .take(10);

Key Rules

1. Always includeargs and returns validators on all functions
2. Usev.null() for void returns - never omit return validator
3. UsewithIndex() not filter() - define indexes in schema
4. UseinternalQuery/Mutation/Action for private functions
5. Actions cannot accessctx.db - use runQuery/runMutation instead
6. Include type annotations when calling functions in same file

Full Compiled Document

For the complete guide with all rules and detailed code examples, see: AGENTS.md

Weekly Installs

96

Repository

cloudai-x/claud…kflow-v2

GitHub Stars

1.3K

First Seen

Jan 21, 2026

Security Audits

Gen Agent Trust HubPassSocketPassSnykPass

Installed on

claude-code76

opencode73

codex69

gemini-cli68

cursor65

github-copilot61