Agent skill

Convex Backend

by CloudAI-X in CloudAI-X/claude-workflow-v2

Convex backend development guidelines. An agent skill from CloudAI-X/claude-workflow-v2.

MITAuto-check passedBackend & APIs

Install Convex Backend

skills CLI
$ npx skills add CloudAI-X/claude-workflow-v2 --skill convex-backend -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install CloudAI-X/claude-workflow-v2 convex-backend --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/CloudAI-X/claude-workflow-v2.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/convex-backend .claude/skills/convex-backend && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
convex-backend
GitHub stars
1.4k
Token cost
~1.1k tokens
SKILL.md length
276 words
Files
2
Skills in repo
13
Repo updated
First seen
Licence
MIT

At a glance

Convex backend development guidelines. An agent skill from CloudAI-X/claude-workflow-v2.

  • Works in 6 steps: Always include args and returns… → Use v.null() for void returns - never… → Use withIndex() not filter() - define… → …
  • Writing Convex functions
  • SKILL.md covers When to Apply, Rule Categories, Quick Reference and Full Compiled Document
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Convex Backend is an agent skill from CloudAI-X/claude-workflow-v2. Convex backend development guidelines. Use when writing Convex functions, schemas, queries, mutations, actions, or any backend code in a Convex project. Triggers on tasks involving Convex database operations, real-time subscriptions, file storage, or serverless functions.

Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. The skill folder holds 1 other file (for example `AGENTS.md`).

It sits in Backend & APIs, covering File uploads and storage and Serverless. It works with Convex. The repository describes itself as: Universal Claude Code workflow plugin with agents, skills, hooks, and commands. The licence is MIT.

When your agent uses it

  • Writing Convex functions
  • Any backend code in a Convex project
  • Tasks involving Convex database operations
  • Real-time subscriptions

Example prompts

  • “/convex-backend”

Requirements

  • Node.js

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

  1. Always include args and returns validators on all functions
  2. Use v.null() for void returns - never omit return validator
  3. Use withIndex() not filter() - define indexes in schema
  4. Use internalQuery/Mutation/Action for private functions
  5. Actions cannot access ctx.db - use runQuery/runMutation instead
  6. Include type annotations when calling functions in same file

What it can do on your machine

Read from SKILL.md and the folder at commit 3b5a89e. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are typescript).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Convex Backend loads about 1.1k tokens when it runs. Until then it costs about 72 tokens; SKILL.md has 276 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~72
When it runs · the whole SKILL.md, loaded when a task matches
~1.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from CloudAI-X/claude-workflow-v2 at commit 3b5a89e, republished under its MIT licence (© CloudAI-X). 276 words, ~1,068 tokens.

Download SKILL.mdSave it as .claude/skills/convex-backend/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
convex-backend
description
Convex backend development guidelines. Use when writing Convex functions, schemas, queries, mutations, actions, or any backend code in a Convex project. Triggers on tasks involving Convex database operations, real-time subscriptions, file storage, or serverless functions.

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

CategoryImpactDescription
Function SyntaxCRITICALNew function syntax with args/returns/handler
ValidatorsCRITICALType-safe argument and return validation
Schema DesignHIGHTable definitions, indexes, system fields
Query PatternsHIGHEfficient data fetching with indexes
Mutation PatternsMEDIUMDatabase writes, patch vs replace
Action PatternsMEDIUMExternal API calls, Node.js runtime
SchedulingMEDIUMCrons and delayed function execution
File StorageLOWBlob storage and metadata

Quick Reference

Function Registration
typescript
// 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)
typescript
export const myFunction = query({
  args: { name: v.string() },
  returns: v.string(),
  handler: async (ctx, args) => {
    return "Hello " + args.name;
  },
});
Common Validators
TypeValidatorExample
Stringv.string()"hello"
Numberv.number()3.14
Booleanv.boolean()true
IDv.id("tableName")doc._id
Arrayv.array(v.string())["a", "b"]
Objectv.object({...}){name: "x"}
Optionalv.optional(v.string())undefined
Unionv.union(v.string(), v.number())"x" or 1
Literalv.literal("status")"status"
Nullv.null()null
Function References
typescript
// 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
typescript
// 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 include args and returns validators on all functions
  2. Use v.null() for void returns - never omit return validator
  3. Use withIndex() not filter() - define indexes in schema
  4. Use internalQuery/Mutation/Action for private functions
  5. Actions cannot access ctx.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.

© CloudAI-X, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file in skills/convex-backend of CloudAI-X/claude-workflow-v2.

  • SKILL.md
  • AGENTS.md

Open the folder on GitHubat commit 3b5a89e

Compare with similar skills

Convex Backend next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Convex Backend compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Convex Backend this skillCloudAI-X/claude-workflow-v21.4k—~1.1kAutomated safety check: PassMIT
uniCloud Cloud Developmentfeige996/unibest2.3k—~813Automated safety check: PassMIT
Edgeone Makers StorageTencentEdgeOne/edgeone-makers-tools1.9k1 repos~930Automated safety check: PassMIT
Neonxai-org/plugin-marketplace281—~3.9kAutomated safety check: NotesNone
Processing S3 Uploads With Step Functionsaws/agent-toolkit-for-aws2.8k—~4kAutomated safety check: PassApache-2.0
Neonneondatabase/agent-skills100—~8.7kAutomated safety check: NotesApache-2.0

Similar skills

  • Covers uniCloud for uni-app projects: project and cloud space setup, cloud database CRUD and permissions, cloud functions, storage and datacom components.

    2.3k GitHub stars~813 tokensUpdated 23 days ago
    Backend & APIsAuto-check passed
  • Edgeone Makers Storage

    TencentEdgeOne/edgeone-makers-tools

    KV and Blob storage services on EdgeOne Makers. An agent skill from TencentEdgeOne/edgeone-makers-tools.

    1.9k GitHub starsUsed in 1 repo~930 tokens
    Backend & APIsAuto-check passed
  • Neon

    xai-org/plugin-marketplace

    Overview of the Neon platform for apps and agents, spanning Postgres, Auth, Data API, and the new services: Object Storage, Compute Functions, and AI Gateway.

    281 GitHub stars~3.9k tokensUpdated today
    Backend & APIsAuto-check: notes
  • Official

    Deploy an event-driven workflow that routes S3 uploads to either Lambda or Fargate via Step Functions based on file size.

    2.8k GitHub stars~4k tokensUpdated today
    Backend & APIsAuto-check passed
  • Neon

    neondatabase/agent-skills

    Official

    Overview of Neon, a complete set of cloud backend primitives around Lakebase Postgres: Auth, Object Storage, Functions, and the AI Gateway.

    100 GitHub stars~8.7k tokensUpdated yesterday
    Backend & APIsAuto-check: notes
  • Maplibre Pmtiles Patterns

    maplibre/maplibre-agent-skills

    Serverless vector and raster tiles with PMTiles for MapLibre GL JS — single-file format, HTTP range requests, hosting on S3/R2/GitHub Pages, generating with Planetiler or tippecanoe, and the pmtiles…

    151 GitHub stars~4.6k tokensUpdated 4 days ago
    Backend & APIsAuto-check passed

More from CloudAI-X/claude-workflow-v2

All 13 skills in this repo
  • Analyzing Projects

    CloudAI-X/claude-workflow-v2

    Analyzes codebases to understand structure, tech stack, patterns, and conventions.

    1.4k GitHub starsUsed in 2 repos~937 tokens
    Auto-check passed
  • Designing APIs

    CloudAI-X/claude-workflow-v2

    Designs REST and GraphQL APIs including endpoints, error handling, versioning, and documentation.

    1.4k GitHub starsUsed in 2 repos~1.2k tokens
    Auto-check passed
  • Designing Architecture

    CloudAI-X/claude-workflow-v2

    Designs software architecture and selects appropriate patterns for projects.

    1.4k GitHub starsUsed in 1 repo~1.4k tokens
    Auto-check passed
  • Designing Tests

    CloudAI-X/claude-workflow-v2

    Designs and implements testing strategies for any codebase. An agent skill from CloudAI-X/claude-workflow-v2.

    1.4k GitHub starsUsed in 1 repo~1.5k tokens
    Auto-check passed
  • Managing Git

    CloudAI-X/claude-workflow-v2

    Manages Git workflows including branching, commits, and pull requests.

    1.4k GitHub starsUsed in 1 repo~1.3k tokens
    Auto-check passed
  • Optimizing Performance

    CloudAI-X/claude-workflow-v2

    Analyzes and optimizes application performance across frontend, backend, and database layers.

    1.4k GitHub starsUsed in 1 repo~1.5k tokens
    Auto-check passed

Works with

Categories

Questions about Convex Backend

What does Convex Backend do?

Convex backend development guidelines. An agent skill from CloudAI-X/claude-workflow-v2. Convex Backend is an agent skill from CloudAI-X/claude-workflow-v2. Convex backend development guidelines.

When should I use Convex Backend?

Convex Backend fits situations like: writing Convex functions; any backend code in a Convex project; tasks involving Convex database operations; real-time subscriptions.

How do I install Convex Backend in Claude Code?

Run `npx skills add CloudAI-X/claude-workflow-v2 --skill convex-backend -a claude-code`. Or copy the skill folder (skills/convex-backend in CloudAI-X/claude-workflow-v2) into .claude/skills/convex-backend in your project. Claude Code loads it when a task matches its description.

How do I install Convex Backend in Codex?

Run `npx skills add CloudAI-X/claude-workflow-v2 --skill convex-backend -a codex`. Or copy the skill folder (skills/convex-backend in CloudAI-X/claude-workflow-v2) into .agents/skills/convex-backend in your project. Codex loads it when a task matches its description.

Can I use Convex Backend in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add CloudAI-X/claude-workflow-v2 --skill convex-backend -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/convex-backend, .gemini/skills/convex-backend, .github/skills/convex-backend and .opencode/skills/convex-backend in your project.

What does Convex Backend need to run?

SKILL.md names no scripts, command-line tools or credentials: Convex Backend is instructions for the agent only. Our summary lists: Node.js.

Does Convex Backend access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Convex Backend safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Convex Backend use?

Convex Backend is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Convex Backend use?

About 1.1k tokens (SKILL.md is roughly 4.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Convex Backend?

Skills that share tags, products or a category with Convex Backend: uniCloud Cloud Development (feige996/unibest, 2.3k stars), Edgeone Makers Storage (TencentEdgeOne/edgeone-makers-tools, 1.9k stars), Neon (xai-org/plugin-marketplace, 281 stars) and Processing S3 Uploads With Step Functions (aws/agent-toolkit-for-aws, 2.8k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Convex Backend?

CloudAI-X (a GitHub user) maintains it in CloudAI-X/claude-workflow-v2, which has 1,418 GitHub stars. The repository holds 13 skills in this directory. The repository was last updated on October 6, 2026.

Source: CloudAI-X/claude-workflow-v2 on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.