skills.rest
openclaw
openclawOFFICIAL
Explore all skills by this author →
Website𝕏@openclawGitHub

convex-explain-app

Explains a Convex app's data model, function surface, and auth model from schema and source.

9.4k|1.5k|Updated Jan 3, 2026
Search Tags:#Backend#convex#Data Model#Schema#explain#ARCHITECTURE#Code Analysis
One-click install
npx skills add https://github.com/openclaw/clawhub --skill convex-explain-app
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: convex-explain-app
Source: https://github.com/openclaw/clawhub/tree/main/.agents/skills/convex-explain-app
Command: npx skills add https://github.com/openclaw/clawhub --skill convex-explain-app

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Understanding an unfamiliar Convex codebase requires reading many function files top-to-bottom, which is slow and error-prone. This Skill produces an accurate architectural map of an existing Convex app by reading the two authoritative sources: the schema and the exported function surface.

Core Features & Use Cases

  • Data Model Mapping: Lists every table, its fields, relationships via v.id references, and indexes that reveal intended access paths.
  • Public vs Internal Function Split: Enumerates all exported queries, mutations, and actions, separating the client-reachable API surface from internal functions.
  • Auth and Ownership Description: States how identity is established and how ownership is enforced, including plainly noting when no auth foundation exists.
  • Use Case: Before modifying or auditing a Convex project you inherited, run this Skill to get a scannable map of tables, functions, components, HTTP routes, crons, and one or two end-to-end request flows.

Quick Start

Explain the architecture of the Convex app in this repository, including its data model, public functions, and auth model.

Frequently Asked Questions about convex-explain-app

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I understand an unfamiliar Convex codebase quickly?▼

Read the schema.ts file for the data model and the exported function surface for behavior. This Skill automates that by mapping tables, relationships, indexes, and the public-versus-internal function split into a scannable architecture summary.

What is the difference between public and internal functions in Convex?▼

Public functions (query, mutation, action) are reachable from clients and form the app's API surface, while internal functions (internalQuery and similar) are only callable server-side. The Skill enumerates both and separates them explicitly.

Does explaining a Convex app modify the deployment?▼

No. The Skill is strictly read-only. Any deployment introspection through functionSpec or table listing is classified as read-only, and the application code and data are never modified.

Can this Skill audit my Convex app for security holes?▼

No. It describes the auth and ownership model as it exists, including stating when there is no auth foundation, but auditing for vulnerabilities is delegated to the convex-authz capability and code review to convex-reviewer.

What does the Skill do when no Convex deployment exists?▼

When no deployment exists, it reads the source directly: schema.ts for the data model, function files for the surface, convex.config.ts for components, and http.ts for routes, flagging ambiguity instead of guessing.

Related Skills

Explore More Software Engineering Skills→
jcdiv47jcdiv47

convex-quickstart

Initialize a Convex backend with schema, auth, and CRUD scaffolding.

Community
Intermediate
andrewvaughanandrewvaughan
12

gtm-review

Run a GTM review consolidating readiness gaps across marketing, product, and engineering.

Community
Advanced
matixlolmatixlol

convex-mcp

Query Convex databases via the Convex MCP server for schema and data inspection.

Community
Intermediate
jcdiv47jcdiv47

components-guide

Encapsulate backend features into reusable Convex components with isolated schemas.

Community
Intermediate