convex-schema-validator

Type-safe database schema definition with indexes, validation, and migration strategies for Convex.

waynesutton/convexskills|Updated Apr 8, 2026

Works with

Claude CodeCursorClineWindsurfCodexGoose

What it does

Supports 13+ validator types including strings, numbers, booleans, document references, arrays, objects, unions, and discriminated unions for flexible data modeling
Enables single-field and compound indexes plus full-text search indexes for optimized query performance
Provides optional and nullable field patterns with clear migration paths for adding required fields and backfilling dat

Repository

waynesutton/convexskills

Last updated

Apr 8, 2026

Installation Guide

Select your AI agent

How to use convex-schema-validator on Cursor

AI-first code editor with Composer

Prerequisites

Before installing skills in Cursor, ensure your development environment meets these requirements:

›Cursor installed and configured on your machine
›Node.js 16+ with npm — verify with node --version
›Active project directory where you want to add convex-schema-validator

Run the install command

Execute the skills CLI command in your project's root directory to begin installation:

$npx skills add https://github.com/waynesutton/convexskills --skill convex-schema-validator

Fetches convex-schema-validator from waynesutton/convexskills and configures it for Cursor.

Select Cursor when prompted

The CLI shows a list of agents. Use arrow keys and space to select Cursor:

◆ Which agents do you want to install to?

│

│ ── Universal (.agents/skills) ────────────────

│ · Cline · Codex · Goose · Windsurf

│ ●Cursor(selected)

│ · Cursor · Aider · Continue

Verify installation

Confirm successful installation by checking the skill directory location:

.cursor/skills/convex-schema-validator

Restart Cursor to activate convex-schema-validator. Access via /convex-schema-validator in your agent's command palette.

⚠

Security Notice

We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.

Skills execute code in your environment. Always review source, verify the publisher, and test in isolation before production.

›View source on GitHub ›Skills CLI docs ›About Cursor ›What are agent skills?

Documentation

List & Monetize Your Skill

Submit your Claude Code skill and start earning

Get started →

Use Cases

User Story & Requirements Generation

Create detailed user stories, acceptance criteria, and feature specs

Example

Generate user stories for 'password reset feature' with acceptance criteria, edge cases, and test scenarios

✓

Reduce spec writing time by 50%, ensure comprehensive coverage

Competitive Analysis

Research competitors, compare features, identify gaps

Example

Analyze 5 competitor products, create feature comparison matrix, suggest differentiation opportunities

✓

Complete competitive research in 2 hours instead of 2 days

Roadmap Prioritization

Evaluate features using frameworks (RICE, ICE, Kano) and create prioritized backlogs

Example

Score 20 feature ideas using RICE framework, generate prioritized roadmap with rationale

Instructions

Basic Schema Definition

// convex/schema.ts import { defineSchema, defineTable } from "convex/server"; import { v } from "convex/values"; export default defineSchema({ users: defineTable({ name: v.string(), email: v.string(), avatarUrl: v.optional(v.string()), createdAt: v.number(), }), tasks: defineTable({ title: v.string(), description: v.optional(v.string()), completed: v.boolean(), userId: v.id("users"), priority: v.union( v.literal("low"), v.literal("medium"), v.literal("high") ), }), });

Validator Types

Validator

TypeScript Type

Example

v.string()

string

"hello"

v.number()

number

42, 3.14

v.boolean()

boolean

true, false

v.null()

null

v.int64()

bigint

9007199254740993n

v.bytes()

ArrayBuffer

Binary data

v.id("table")

Id<"table">

Document reference

v.array(v)

T[]

[1, 2, 3]

v.object({})

{ ... }

{ name: "..." }

v.optional(v)

T | undefined

Optional field

v.union(...)

T1 | T2

Multiple types

v.literal(x)

"x"

Exact value

v.any()

any

Any value

v.record(k, v)

Record<K, V>

Dynamic keys

Index Configuration

export default defineSchema({ messages: defineTable({ channelId: v.id("channels"), authorId: v.id("users"), content: v.string(), sentAt: v.number(), }) // Single field index .index("by_channel", ["channelId"]) // Compound index .index("by_channel_and_author", ["channelId", "authorId"]) // Index for sorting .index("by_channel_and_time", ["channelId", "sentAt"]), // Full-text search index articles: defineTable({ title: v.string(), body: v.string(), category: v.string(), }) .searchIndex("search_content", { searchField: "body", filterFields: ["category"], }), });

Complex Types

export default defineSchema({ // Nested objects profiles: defineTable({ userId: v.id("users"), settings: v.object({ theme: v.union(v.literal("light"), v.literal("dark")), notifications: v.object({ email: v.boolean(), push: v.boolean(), }), }), }), // Arrays of objects orders: defineTable({ customerId: v.id("users"), items: v.array(v.object({ productId: v.id("products"), quantity: v.number(), price: v.number(), })), status: v.union( v.literal("pending"), v.literal("processing"), v.literal("shipped"), v.literal("delivered") ), }), // Record type for dynamic keys analytics: defineTable({ date: v.string(), metrics: v.record(v.string(), v.number()), }), });

Discriminated Unions

export default defineSchema({ events: defineTable( v.union( v.object({ type: v.literal("user_signup"

convex-schema-validator

What it does

Category

Repository

Last updated

Installation Guide

How to use convex-schema-validator on Cursor

Prerequisites

Run the install command

Select Cursor when prompted

Verify installation

Security Notice

Documentation

List & Monetize Your Skill

Use Cases

User Story & Requirements Generation

Competitive Analysis

Roadmap Prioritization

Install Skill

Convex Schema Validator

Documentation Sources

Instructions

Basic Schema Definition

Validator Types

Index Configuration

Complex Types

Discriminated Unions

Stakeholder Communication

Implementation Guide

Best Practices

When to Use This

Learning Path

Related Skills

grill-me

premortem

deslop

framer-motion

write-a-prd

travel-planner

Reviews

Discussion

`Stakeholder Communication`

`Implementation Guide`

`Best Practices`

`When to Use This`

`Learning Path`

`Related Skills`

`Reviews`

`Discussion`