convex-performance-audit

get-convex/agent-skills · updated Apr 8, 2026

MDX-style export adds YAML metadata + attribution linking explainx.ai and this canonical listing URL.

$npx skills add https://github.com/get-convex/agent-skills --skill convex-performance-audit
0 commentsdiscussion
summary

Diagnose and resolve Convex performance issues across reads, writes, subscriptions, and function limits.

  • Covers four problem classes: hot-path reads and data amplification, OCC write conflicts and contention, subscription cost and reactivity overhead, and function execution or transaction size limits
  • Starts with signal gathering from deployment health insights or CLI tools, then routes to the relevant reference guide based on the problem type
  • Emphasizes tracing full read and write se
skill.md

Convex Performance Audit

Diagnose and fix performance problems in Convex applications, one problem class at a time.

When to Use

  • A Convex page or feature feels slow or expensive
  • npx convex insights --details reports high bytes read, documents read, or OCC conflicts
  • Low-freshness read paths are using reactivity where point-in-time reads would do
  • OCC conflict errors or excessive mutation retries
  • High subscription count or slow UI updates
  • Functions approaching execution or transaction limits
  • The same performance pattern needs fixing across sibling functions

When Not to Use

  • Initial Convex setup, auth setup, or component extraction
  • Pure schema migrations with no performance goal
  • One-off micro-optimizations without a user-visible or deployment-visible problem

Guardrails

  • Prefer simpler code when scale is small, traffic is modest, or the available signals are weak
  • Do not recommend digest tables, document splitting, fetch-strategy changes, or migration-heavy rollouts unless there is a measured signal, a clearly unbounded path, or a known hot read/write path
  • In Convex, a simple scan on a small table is often acceptable. Do not invent structural work just because a pattern is not ideal at large scale

First Step: Gather Signals

Start with the strongest signal available:

  1. If deployment Health insights are already available from the user or the current context, treat them as a first-class source of performance signals.
  2. If CLI insights are available, run npx convex insights --details. Use --prod, --preview-name, or --deployment-name when needed.
    • If the local repo's Convex CLI is too old to support insights, try npx -y convex@latest insights --details before giving up.
  3. If the repo already uses convex-doctor, you may treat its findings as hints. Do not require it, and do not treat it as the source of truth.
  4. If runtime signals are unavailable, audit from code anyway, but keep the guardrails above in mind. Lack of insights is not proof of health, but it is also not proof that a large refactor is warranted.

Signal Routing

After gathering signals, identify the problem class and read the matching reference file.

Signal Reference
High bytes or documents read, JS filtering, unnecessary joins references/hot-path-rules.md
OCC conflict errors, write contention, mutation retries references/occ-conflicts.md
High subscription count, slow UI updates, excessive re-renders references/subscription-cost.md
Function timeouts, transaction size errors, large payloads references/function-budget.md
General "it's slow" with no specific signal Start with references/hot-path-rules.md

Multiple problem classes can overlap. Read the most relevant reference first, then check the others if symptoms remain.

Escalate Larger Fixes

If the likely fix is invasive, cross-cutting, or migration-heavy, stop and present options before editing.

Examples:

  • introducing digest or summary tables across multiple flows
  • splitting documents to isolate frequently-updated fields
  • reworking pagination or fetch strategy across several screens
  • switching to a new index or denormalized field that needs migration-safe rollout

When correctness depends on handling old and new states during a rollout, consult skills/convex-migration-helper/SKILL.md for the migration workflow.

Workflow

1. Scope the problem

Pick one concrete user flow from the actual project. Look at the codebase, client pages, and API surface to find the flow that matches the symptom.

Write down:

  • entrypoint functions
  • client callsites using useQuery, usePaginatedQuery, or useMutation
  • tables read
  • tables written
  • whether the path is high-read, high-write, or both

2. Trace the full read and write set

For each function in the path:

  1. Trace every ctx.db.get() and ctx.db.query()
  2. Trace every ctx.db.patch(), ctx.db.replace(), and ctx.db.insert()
  3. Note foreign-key lookups, JS-side filtering, and full-document reads
  4. Identify all sibling functions touching the same tables
  5. Identify reactive stats, aggregates, or widgets rendered on the same page

In Convex, every extra read increases transaction work, and every write can invalidate reactive subscribers. Treat read amplification and invalidation amplification as first-class problems.

3. Apply fixes from the relevant reference

Read the reference file matching your problem class. Each reference includes specific patterns, code examples, and a recommended fix order.

Do not stop at the single function named by an insight. Trace sibling readers and writers touching the same tables.

4. Fix sibling functions together

When one function touching a table has a performance bug, audit sibling functions for the same pattern.

After finding one problem, inspect both sibling readers and sibling writers for the same table family, including companion digest or summary tables.

Examples:

  • If one list query switches from full docs to a digest table, inspect the other list queries for that table
  • If one mutation needs no-op write protection, inspect the other writers to the same table
  • If one read path needs a migration-safe rollout for an unbackfilled field, inspect sibling reads for the same rollout risk

Do not leave one path fixed and another path on the old pattern unless there is a clear product reason.

5. Verify before finishing

Confirm all of these:

  1. Results are the same as before, no dropped records
  2. Eliminated reads or writes are no longer in the path where expected
  3. Fallback behavior works when denormalized or indexed fields are missing
  4. New writes avoid unnecessary invalidation when data is unchanged
  5. Every relevant sibling reader and writer was inspected, not just the original function

Reference Files

  • references/hot-path-rules.md - Read amplification, invalidation, denormalization, indexes, digest tables
  • references/occ-conflicts.md - Write contention, OCC resolution, hot document splitting
  • references/subscription-cost.md - Reactive query cost, subscription granularity, point-in-time reads
  • references/function-budget.md - Execution limits, transaction size, large documents, payload size

Also check the official Convex Best Practices page for additional patterns covering argument validation, access control, and code organization that may surface during the audit.

Checklist

  • Gathered signals from insights, dashboard, or code audit
  • Identified the problem class and read the matching reference
  • Scoped one concrete user flow or function path
  • Traced every read and write in that path
  • Identified sibling functions touching the same tables
  • Applied fixes from the reference, following the recommended fix order
  • Fixed sibling functions consistently
  • Verified behavior and confirmed no regressions
how to use convex-performance-audit

How to use convex-performance-audit on Cursor

AI-first code editor with Composer

1

Prerequisites

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

  • Cursor installed and configured on your development machine
  • Node.js version 16.0+ with npm package manager (verify with node --version)
  • Active project directory or workspace where you want to add convex-performance-audit
2

Execute installation command

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

$npx skills add https://github.com/get-convex/agent-skills --skill convex-performance-audit

The skills CLI fetches convex-performance-audit from GitHub repository get-convex/agent-skills and configures it for Cursor.

3

Select Cursor when prompted

The CLI will show a list of available agents. Use arrow keys to navigate and space to select Cursor:

◆ Which agents do you want to install to?
│ ── Universal (.agents/skills) ── always included ────
│ • Amp
│ • Antigravity
│ • Cline
│ • Codex
│ ●Cursor(selected)
│ • Cursor
│ • Windsurf
4

Verify installation

Confirm successful installation by checking the skill directory location:

.cursor/skills/convex-performance-audit

Reload or restart Cursor to activate convex-performance-audit. Access the skill through slash commands (e.g., /convex-performance-audit) or your agent's skill management interface.

Security & Verification 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 development environment. Always verify the publisher's identity, review recent commits, and test in isolated environments before production deployment.

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

Make data-driven prioritization decisions faster

Stakeholder Communication

Draft PRDs, status updates, and stakeholder presentations

Example

Create executive summary of Q3 roadmap, monthly progress report, feature launch announcement

Save 3-5 hours/week on communication overhead

Implementation Guide

Prerequisites

  • Claude Desktop or compatible AI client
  • Access to product documentation and roadmap tools (Jira, Notion, etc.)
  • Understanding of product management frameworks (RICE, Jobs-to-be-Done, etc.)
  • Stakeholder contact information and communication channels

Time Estimate

30-60 minutes to see productivity improvements

Installation Steps

  1. 1.Install product management skill
  2. 2.Start with user story generation for known feature
  3. 3.Progress to competitive analysis: research 2-3 competitors
  4. 4.Use for roadmap prioritization: apply RICE/ICE scoring
  5. 5.Draft stakeholder communications and refine based on feedback
  6. 6.Build template library for recurring PM tasks
  7. 7.Share effective prompts with product team

Common Pitfalls

  • Not validating competitive research—verify facts before sharing
  • Accepting user stories without involving engineering team
  • Over-relying on frameworks without qualitative judgment
  • Not customizing outputs to company culture and communication style
  • Skipping stakeholder validation of generated requirements

Best Practices

✓ Do

  • +Validate research and competitive analysis with real data
  • +Collaborate with engineering when generating technical requirements
  • +Customize frameworks and templates to your company context
  • +Use skill for first drafts, refine with stakeholder input
  • +Document successful prompt patterns for PM tasks
  • +Combine AI efficiency with human judgment and intuition

✗ Don't

  • Don't publish competitive analysis without fact-checking
  • Don't finalize user stories without engineering review
  • Don't make prioritization decisions solely on AI scoring
  • Don't skip customer validation of generated requirements
  • Don't ignore company-specific context and culture

💡 Pro Tips

  • Provide context: company goals, constraints, customer feedback
  • Ask for alternatives: 'Show 3 ways to prioritize this roadmap'
  • Request stakeholder-specific formatting: 'Executive summary vs. engineering spec'
  • Use skill for 70% generation + 30% customization to company needs

When to Use This

✓ Use When

Use for user story writing, competitive research, roadmap prioritization, stakeholder communication, and PRD drafting. Best for reducing repetitive documentation and research work.

✗ Avoid When

Avoid for strategic product vision (requires deep customer empathy), pricing decisions (needs market and financial expertise), or when face-to-face customer discovery is more valuable than speed.

Learning Path

  1. 1Basic: user stories, feature specs, status updates
  2. 2Intermediate: competitive analysis, prioritization frameworks, PRDs
  3. 3Advanced: product strategy, go-to-market planning, OKR setting
  4. 4Expert: product vision, market positioning, business model innovation

Discussion

Product Hunt–style comments (not star reviews)
  • No comments yet — start the thread.
general reviews

Ratings

4.845 reviews
  • Ren Martinez· Dec 28, 2024

    convex-performance-audit is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.

  • Ganesh Mohane· Dec 24, 2024

    convex-performance-audit fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.

  • Shikha Mishra· Dec 16, 2024

    Useful defaults in convex-performance-audit — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

  • Ira Liu· Dec 12, 2024

    Registry listing for convex-performance-audit matched our evaluation — installs cleanly and behaves as described in the markdown.

  • Michael Sethi· Dec 12, 2024

    convex-performance-audit reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • Ren Khan· Nov 19, 2024

    convex-performance-audit reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • Yash Thakker· Nov 7, 2024

    convex-performance-audit has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • Aditi Harris· Nov 3, 2024

    Keeps context tight: convex-performance-audit is the kind of skill you can hand to a new teammate without a long onboarding doc.

  • Ren Park· Nov 3, 2024

    convex-performance-audit is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.

  • Dhruvi Jain· Oct 26, 2024

    Solid pick for teams standardizing on skills: convex-performance-audit is focused, and the summary matches what you get after install.

showing 1-10 of 45

1 / 5