Guide · Agent skill
How to use the Convex Docs Lookup agent skill (convex-docs)
Updated · written with AI from the project's own documentation and checked against our catalogue data
The convex-docs skill is a set of instructions that an AI coding agent loads when you work on a Convex project. Convex is a backend platform whose APIs change between versions, and AI models often write code from outdated memory. This skill makes the agent read the exact Convex and component versions your project uses, then look up current documentation or check the installed type definitions before writing code. This guide explains what the skill does, how to install it, how to trigger it, and where its limits are.
Current Convex Docs Lookupopenclaw/clawhub · MIT Download the skill Quick start
- 1Download the ZIP. Get the convex-docs skill ZIP from this page. It contains SKILL.md.
- 2Unzip into a skills folder. Place the convex-docs folder in ~/.claude/skills/ for personal use, or in your project's .claude/skills/ folder for one project.
- 3Or upload in the Claude apps. In the Claude apps, open Settings, go to Capabilities, and upload the skill under Skills.
- 4Confirm your dependencies are installed. Make sure your Convex project has the convex package in node_modules, since the skill reads versions and type definitions from there.
- 5Ask for Convex work in plain language. Describe the task, mentioning the version or upgrade if relevant, so the agent loads the skill.
- 6Review the cited version and source. Check that the version and docs page the agent names match your project before you rely on the code.
What the convex-docs skill makes the agent do
The skill tells the agent to pin the version first. It reads the installed convex version from node_modules/convex/package.json (or package.json), and the versions of any @convex-dev/* components the project uses. The documentation it trusts must match those versions.
It then follows a freshness order, cheapest correct source first: a served docs tool such as search_convex_docs if one is available, then a specific docs page fetched as markdown from docs.convex.dev, and only then a general web search, whose version the agent treats as unverified. For component exports it is unsure about, the agent can check the installed package's exports and .d.ts files in node_modules, which the skill describes as the ground truth for your version.
The skill is a freshness layer. It supplies the current fact, such as a signature or flag, and the agent then hands the actual code writing to a general Convex coding skill (convex-expert in the source).
- Reads the pinned convex and @convex-dev component versions
- Prefers a docs search tool, then markdown docs pages, then web search
- Checks node_modules type definitions when an export is uncertain
- Treats a version-mismatch build error as a version question, not a spelling guess
Install the convex-docs skill
Download the skill ZIP from the page where you found this guide. The skill's file is SKILL.md, inside a folder named convex-docs.
To install it for yourself across projects, unzip it into ~/.claude/skills/. To install it for a single project, unzip it into that project's .claude/skills/ folder. Both locations are described in the source of this skill.
Alternatively, if you use the Claude apps, open Settings, go to Capabilities, and upload the skill under Skills.
- Personal install: ~/.claude/skills/
- Project install: .claude/skills/ inside your project
- Claude apps: Settings → Capabilities → Skills → upload
Trigger the skill with natural requests
You do not need a special command. Ask for Convex work in plain language, especially when the question involves a version, an upgrade, or an API you are unsure about. The skill is written to load when a currentness question comes up, such as an export that may have been renamed or a flag that changed between releases.
Requests that fit well include asking the agent to check the Convex version before writing code, asking for the current signature of a component function, or pasting a build error that appears after you upgraded the convex package.
- "Check which convex version this project uses, then write the query using that version's API."
- "I upgraded @convex-dev/ and now the export is missing. Look up the current API."
- "Is this function still in the installed version of the component? Check its type definitions."
- "Fetch the current Convex docs page on scheduled functions and use the signature that matches my version."
Know what the skill needs and what it does on your machine
The skill needs Node.js, because the agent reads package.json versions with node. Your project must use Convex with the convex package installed in node_modules. Network access to docs.convex.dev is needed to fetch docs pages, although it is optional if the agent has a docs tool available.
The skill runs scripts and uses the network. The version-reading step runs a small node command, and fetching docs pages sends requests to docs.convex.dev. Review the SKILL.md file before installing if you need to confirm exactly what the agent will run in your environment.
- Requires Node.js
- Requires a project with the convex package in node_modules
- Runs scripts: yes
- Uses network: yes (docs.convex.dev, optional if a docs tool is present)
node -p "require('./node_modules/convex/package.json').version"Get the most out of it
Keep your dependencies installed so the agent can read the real versions and type definitions. Without a node_modules folder, the agent cannot check the installed types, and the version pin step has nothing to read.
When the agent cites a fact, check that the page and version it names match your project. If it falls back to a general web search, the skill itself says that version is unverified, so confirm it before relying on it.
- Run npm install (or your package manager's install) before asking so node_modules is present
- Ask the agent to report which version it pinned and where the fact came from
- Use the skill for upgrade errors and uncertain APIs rather than for stable, familiar patterns
What people use it for
- Fixing a build error after upgrading the convex package by looking up the current API for the installed version
- Writing a call to a @convex-dev component using the export that exists in the installed node_modules types
- Checking a CLI flag or function signature against the docs page for your pinned version before adding it to a project
- Getting a version-matched answer for a query or mutation pattern when your team pins specific Convex versions
Frequently asked questions
What is the convex-docs agent skill?
It is a SKILL.md instruction file that tells an AI agent to read your project's pinned Convex and component versions, then look up current documentation or check installed type definitions before writing Convex code. It is designed to prevent code written from outdated memory.
How do I install the convex-docs skill?
Download the ZIP from this page and unzip it into ~/.claude/skills/ for personal use or into a project's .claude/skills/ folder. In the Claude apps, you can instead upload it under Settings, then Capabilities, then Skills.
What does convex-docs require?
It requires Node.js, a project that uses Convex with the convex package installed in node_modules, and network access to docs.convex.dev for fetching docs pages. Network access is optional if a docs tool is available to the agent.
Is convex-docs free and what is its licence?
The skill is listed under the MIT licence. This page does not state any price, so check the directory listing for the current terms.
Does the skill run scripts or use the internet?
Yes on both counts. It runs a node command to read package versions and uses the network to fetch docs pages from docs.convex.dev. Review SKILL.md before installing if you need to confirm this in your environment.
Can I use this for projects that are not on Convex?
No. The instructions only cover Convex and its components, so the skill is not meant for other backend platforms. For quick questions about stable, long-established Convex patterns, the lookup steps add time and tokens without much benefit.
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-docs if you build on Convex and have hit errors after upgrading the convex package or a @convex-dev component, or if your team wants AI-written code to match pinned versions. Skip it if your project does not use Convex, or if you mostly ask about stable patterns where version drift is not a concern, since the lookup steps add cost.
Download the skill