convex-schema-validator

Validate Convex schema definitions for typing, indexes, and migrations.

Updated Apr 10, 2026
One-click install
npx skills add https://github.com/qdhenry/Foundry-OSS --skill convex-schema-validator-qdhenry
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-schema-validator
Source: https://github.com/qdhenry/Foundry-OSS/tree/main/.agents/skills/convex-schema-validator
Command: npx skills add https://github.com/qdhenry/Foundry-OSS --skill convex-schema-validator-qdhenry

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex schema validator ensures schemas are well-typed, correctly indexed, and safely migratable, preventing runtime schema errors and data integrity issues across Convex applications. It provides a formal schema definition and robust validation logic to keep your data model consistent as your project evolves.

Core Features & Use Cases

  • Define and validate complex Convex schemas with support for optional fields, unions, arrays, and migrations.
  • Enforce index configurations, discriminated unions, and migration strategies to maintain data integrity across evolution.
  • Use cases include designing robust user models, auditing migrations, and validating schemas in CI pipelines.

Quick Start

Define a Convex schema and run the validator to ensure correct typing, indexes, and migrations.

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 a Convex schema to prevent runtime errors?

You can validate a Convex schema by checking table definitions, fields, and relationships against strict typing rules. This process ensures correct index configurations and safe migration strategies, preventing data integrity issues across your application.

Can I validate discriminated unions and optional fields in Convex schemas?

Yes, schema validation supports optional fields, unions, arrays, and discriminated unions. Defining these complex structures formally allows the validator to enforce strict typing and maintain data model consistency as your project evolves.

How do I enforce index configurations and migration strategies in Convex?

You enforce index configurations and migration strategies by providing detailed schema bodies and migration scripts for validation. This approach targets schema design tasks to ensure correct tables and relationships are safely migrated without data loss.

Does TypeScript schema validation work for CI pipelines in Convex projects?

TypeScript schema validation is designed for use in CI pipelines to audit migrations and validate schemas. It requires detailed schema bodies and reports errors formally, keeping your data model consistent during continuous integration.

What are common schema validation limitations when migrating Convex tables?

Validation requires comprehensive schema bodies and migration scripts to function correctly. Without detailed definitions of tables, fields, and relationships, the validator cannot enforce migration strategies or report errors effectively.