Skip to content

Explain a Convex App

Map a Convex app's data model, public vs internal functions, and auth model from its source

Stars
9,546
Licence
MIT
Files
1 file

What it does

When installed, the agent reads a Convex app's schema and function files and produces a structured map: which database tables exist and how they relate, which functions are client-reachable (public) versus internal, how users and ownership are identified, and what external services or components the app uses. It also traces example request paths through the code. It is designed to be read-only and descriptive, so it explains the app without changing it, and points to other skills for auditing or changes.

Great for

  • Developers taking over or onboarding onto an unfamiliar Convex codebase
  • Engineers who need a quick architecture overview before making changes
  • Teams preparing to run a security or launch-readiness review

Skip it if

  • Finding security holes or bugs, since it describes the app rather than auditing it (use the separate audit skills for that)
  • Non-Convex backends, because it targets Convex schema and function conventions
  • Apps whose source is unavailable, since it relies on reading the schema and function code

Try asking

  • “Explain this Convex app: what tables exist and how they relate”
  • “Which of my Convex functions are public and which are internal?”
  • “Map the auth and ownership model in this Convex project”
  • “Trace what happens from a client calling createTask through to the database”
Step-by-step guide: how to use Explain a Convex AppInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 1 original files, the MIT licence and an attribution note.

    convex-explain-app.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip convex-explain-app.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip convex-explain-app.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Point the agent at the project root so it can find convex/schema.ts and the function files
  • If you have a deployment, allow read-only introspection for the most authoritative function list
  • Use the output as the starting point, then ask a follow-up skill to audit or score the app

What's inside

  • SKILL.md

Redistributed unmodified from openclaw/clawhub under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.