Description
convex-explain-app is an agent skill that explains an existing Convex app, so you can understand it before you change it. Reading every function file by hand is slow and error-prone, so the skill builds a map from the two sources that describe the app accurately: the schema, which holds the data model, and the function surface, meaning the exported queries, mutations and actions. The explanation covers the data model and the relationships between tables, the public and internal functions, the authentication and ownership model, the components in use, and the flow of a request through the app to the data it touches. The skill is deliberately descriptive. It explains what the app is, and it leaves judgement about problems to the audit skills and changes to the fixing skills. If a deployment exists, the skill can use the official Convex MCP to read the live function list, which it treats as the authoritative surface, and it classifies any deployment read as read-only. It is useful as the first step of an optimisation or repair session. It is part of the get-convex agent-skills repository and is added to a compatible agent with the skills command. Its audits passed with Gen Agent Trust Hub, Socket and Snyk.…
Highlights
- Maps tables, fields and relationships
- Lists public and internal functions
- Explains the auth and ownership model
- Reads the live surface when a deployment exists
Ratings & Reviews
No ratings yet
Be the first to rate convex-explain-app.
People also visit
convex-explain-app FAQ
What does convex-explain-app produce?
A map of an existing Convex app, covering its data model, functions, auth and request flow.
Does it change the app?
No. It is descriptive, and it hands judgement to the audit skills and changes to the fixers.
What sources does it read?
The schema and the function surface, and the live function list from the Convex MCP when a deployment exists.
How do I install it?
Run: npx skills add https://github.com/get-convex/agent-skills --skill convex-explain-app
What security audits has it passed?
Gen Agent Trust Hub, Socket and Snyk all passed.
What are the best convex-explain-app alternatives?
Popular alternatives to convex-explain-app include architecture-decision-records, documentation-and-adrs and understand. See all convex-explain-app alternatives