Guide · Agent skill
How to use the Convex App Optimizer agent skill (convex-optimize)
Updated · written with AI from the project's own documentation and checked against our catalogue data
convex-optimize is an agent skill that makes an AI coding agent audit and clean up an existing Convex app, a backend platform for web apps. It is aimed at developers who inherited or maintain a Convex project and want a prioritized cleanup plan. After this guide you will know what the skill does, how to install it, how to ask for it in plain language, and what to check before letting it change your code.
Quick start
- 1Download and unzip. Download the ZIP from this page and unzip it so that the convex-optimize folder contains SKILL.md.
- 2Place the folder. Move the folder to ~/.claude/skills/ for personal use, or to .claude/skills/ inside your project. Alternatively, upload the ZIP under Settings → Capabilities → Skills in the Claude apps.
- 3Install the companion skills. Make sure launch-readiness, check-updates and sentinel are installed too, since this skill delegates to them and they are not included in this package.
- 4Back up your project. Commit your current work to version control or make a backup so you can revert any change.
- 5Ask for an audit. In your Convex project, ask the agent in plain language to audit and optimize the app.
- 6Review and confirm the plan. Read the single prioritized plan, with security and data-loss issues first, and confirm only the fixes you accept.
- 7Check the score change. After fixes are applied, the agent re-runs the assessment and shows how the score moved.
What is an agent skill?
An agent skill is a folder of instructions that an AI agent, such as Claude, loads when a request matches the skill's purpose. The skill tells the agent which steps to follow, in what order, and what it may do. This skill is packaged as a folder containing a single file named SKILL.md.
What does the convex-optimize skill make the agent do?
For an existing Convex app, the agent follows a fixed workflow. It first detects the project by looking for a convex/ directory, the schema, and whether the deployment is anonymous or cloud. It then runs a scored assessment by delegating to the separate launch-readiness skill, which is not included in this package.
- Checks whether the Convex components your app depends on (@convex-dev/* packages) are out of date, using the check-updates skill.
- Offers to set up production error monitoring with the sentinel skill if the readiness report flags that no production errors are captured.
- Presents one combined, prioritized plan with security and data-loss issues first.
- Changes files only after you explicitly confirm.
- Re-runs the assessment after fixes and shows how the score changed.
How do you install the skill?
The skill is distributed as a ZIP file from the download link on this page. Unzip it so that the convex-optimize folder, containing SKILL.md, sits in one of these locations:
- Personal: ~/.claude/skills/ (available across your projects).
- Project only: a .claude/skills/ folder inside your Convex project.
- Claude apps: upload the ZIP under Settings → Capabilities → Skills.
How do you trigger the skill with a natural request?
You do not need a special command. Describe what you want in plain language while working in your Convex project. Requests that match the skill's purpose include auditing, optimizing, checking security, checking for upgrades, or preparing for launch. Mention that the app is Convex so the agent loads the right workflow.
- "Audit my Convex app and give me a prioritized cleanup plan."
- "Check whether my Convex components are out of date."
- "Get this Convex app ready for launch, including error monitoring."
- "Review the security and data-loss risks in my convex/ folder before we change anything."
What do you need before you run it?
The skill only works on a Convex project. The workflow depends on Convex conventions such as the convex/ directory and @convex-dev components. The skill also references three other skills that are not included in this package.
- A Convex project with a convex/ directory.
- The launch-readiness skill, which performs the assessment. Without it the scored audit will not run.
- The check-updates skill, for component upgrade checks.
- The sentinel skill, for observability setup.
What should you know about safety?
The skill is designed to act on code, so treat it with care. According to the source, the skill does not run scripts and does not use the network. It can, however, modify your files after you confirm a plan. Its workflow is read-only until you confirm, and it is designed not to auto-land changes on an existing production app and to re-assess after applying fixes.
Before confirming changes, keep your project under version control and make a backup. Review the plan and the diff carefully, especially for live production code.
- Make a commit or backup before you approve any changes.
- Read the prioritized plan first; security and data-loss items appear at the top.
- Do not confirm a plan you do not understand.
What people use it for
- Taking over a Convex app from another developer and getting a prioritized list of security and data-loss risks.
- Checking whether the @convex-dev components in a maintained app have stale versions that need upgrading.
- Preparing a Convex app for launch and adding production error monitoring in the same pass.
- Reviewing a project before a large refactor so you know which issues to address first.
Frequently asked questions
Is the convex-optimize skill free and open source?
The source lists the licence as MIT. Check the license file in the download for the full terms before you use or redistribute it.
What do I need to install before convex-optimize works?
You need a Convex project with a convex/ directory, plus the launch-readiness, check-updates and sentinel skills. The source says those three are referenced but not included in this skill's files, so they must be installed separately.
Where do I put the convex-optimize folder?
Place it in ~/.claude/skills/ for personal use or in .claude/skills/ inside your project. In the Claude apps, you can upload the ZIP under Settings → Capabilities → Skills.
Will the skill change my code automatically?
No. The workflow presents a plan first and only changes files after you explicitly confirm. It is still wise to back up or version-control your project before confirming.
Does this skill work on projects that are not Convex?
No. The workflow depends on Convex conventions such as the convex/ directory and @convex-dev components, so it will not help with other frameworks.
Can I use convex-optimize as a standalone audit tool?
Not on its own. The assessment is delegated to launch-readiness, so the scored audit depends on that skill being installed. Without it, parts of the workflow may not work.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Use convex-optimize if you maintain or inherited a Convex app and want one prioritized plan covering security, stale components and error monitoring, with changes applied only after you confirm. Pick something else if you need a standalone audit, work on a non-Convex project, or cannot risk changes to live production code without thorough review.
Download the skill