convex-schema-validator

Validate Convex database schemas for typing, indexes, and migrations.

1|1|Updated Feb 24, 2026
One-click install
npx skills add https://github.com/openridesph/openrides --skill convex-schema-validator-openridesph
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-schema-validator
Source: https://github.com/openridesph/openrides/tree/main/.agents/skills/convex-schema-validator
Command: npx skills add https://github.com/openridesph/openrides --skill convex-schema-validator-openridesph

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex schema design requires precise typing and migrations; this tool helps define and validate database schemas with strong type-safety and clear contracts.

Core Features & Use Cases

  • Define schemas with defineSchema and defineTable, including optional/nullable fields, unions, and discriminated types.
  • Validate indexes, full-text search configuration, and migration strategies to ensure safe schema changes across environments.
  • Use cases include building robust Convex data models for users, products, and events with enforced typing and migrations.

Quick Start

Create a convex/schema.ts with your table definitions and run the validator to verify correctness.

Frequently Asked Questions about convex-schema-validator

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

FAQPage Schema
How do I validate my Convex database schema for correct typing?

To validate your Convex database schema, define your tables in a convex/schema.ts file and run the validator to enforce strict type-safety, correct optional/nullable fields, and discriminated unions.

What's the best way to manage Convex migrations and index configuration?

The best way to manage Convex migrations and index configuration is to use a validation tool that enforces safe schema changes across environments, verifying full-text search setup and migration strategies.

Does this schema validation approach support discriminated unions in Convex?

Yes, this schema validation approach supports discriminated unions in Convex by enforcing definitions using Convex DSL primitives like defineSchema, defineTable, and v.* validators for complex data models.

How do I handle optional and nullable fields when defining a Convex schema?

To handle optional and nullable fields in a Convex schema, apply strict validation rules to your schema.ts definitions, ensuring type-safety and clear contracts for robust data models.

Why do I need to validate indexes and full-text search configuration in Convex?

Validating indexes and full-text search configuration in Convex prevents data retrieval errors and ensures safe schema changes across different environments during database migrations.

Can I use this validator for TypeScript projects building complex Convex data models?

Yes, you can use this validator for TypeScript projects to build robust Convex data models for users, products, and events by enforcing precise typing and clear schema contracts.