Index of every page on this site: llms.txt
All skills
waynesutton avatar

/convex-best-practices

@853b196
Run it yourself

Retired. Points to the skill that replaced convex-best-practices in builder-skills 3.0. Use when /convex-best-practices is invoked by name or the user asks where convex-best-practices went.

Use this Skill: https://skilld.dev/gh/waynesutton/builder-skills/convex-best-practices

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈53 tokens for metadata: the name and description. ≈143 when used: this file. ≈23 more on demand in 1 file.

Description uses 2.7% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈213 characters, or 2.7%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

convex-best-practices (retired)

This skill moved. Use convex-reviewer (official Convex) and convex-optimize (official Convex) instead. Tell the user this, then load the replacement if it is installed.

Install the replacement:

npx skills add convex/agent-skills --skill convex-reviewer --skill convex-optimize

Or set up Convex for your agent in one step: read and follow https://www.convex.dev/agent-setup.md.

Old content: https://github.com/waynesutton/builder-skills/tree/82d1ce2/skills/convex-best-practices. Delete this folder after you switch.

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning1mo3 checks · Risk SAFE
  • Gen Agent Trust Hub1mo

    This skill provides production-grade best practices and configuration guides for building Convex applications. It includes standard instructions for installing official Convex developer tools and setting up ESLint to enforce performance and correctness rules. No malicious patterns were detected.

  • Socket1mo

    No alerts

  • Snyk2mo

    Risk: MEDIUM · 1 issue

Signed by skilld at 853b196. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 6 days ago.

Activeupdated 2 weeks ago

README badge

README badge for waynesutton/builder-skills/convex-best-practices

Teaches patterns for building production Convex applications: function organization by domain, argument and return validation, query indexing, error handling with ConvexError, idempotent mutations, and TypeScript usage. Includes the @convex-dev/eslint-plugin for enforcing Convex function syntax and validator rules at build time.

Generated from the current SKILL.md.

Does this skill cover TypeScript usage in Convex?
Yes. The skill includes guidance on leveraging end-to-end type safety with TypeScript, covering the Id and Doc types from the generated dataModel, and best practices for type annotations in functions.
What does the @convex-dev/eslint-plugin enforce?
The plugin enforces four rules: no old registered function syntax, required argument validators on all functions, explicit table names in db operations, and prevention of Node imports in the Convex runtime.
How does this skill address write conflicts?
The skill provides patterns for Convex's optimistic concurrency control: making mutations idempotent, patching directly without reading first when possible, and using Promise.all for parallel independent updates.
Does this skill include examples?
Yes. The skill includes a complete CRUD pattern example, query patterns with indexes, error handling with ConvexError, and patterns for internal vs public functions.
What is the Zen of Convex philosophy covered in this skill?
The skill outlines five core principles: Convex manages caching and consistency, functions are your API, schema is the source of truth, TypeScript should be used everywhere, and queries are reactive subscriptions.

Generated from the current SKILL.md. These answers refresh after source changes.