Convex Docs skill for Claude Code: read the docs for your Convex version
Makes Claude check which Convex version your project uses and read the matching docs before it writes an API it is unsure about.
- Installs
- 38.5K
- on skills.sh
- Stars
- 68
- on GitHub
- Updated
- Oct 2026
- last repo commit
The skill has Claude pin the installed convex version and the versions of any @convex-dev/* components, then look things up cheapest first. It uses a served docs tool or MCP search_convex_docs if one is available. Otherwise it fetches the docs page as markdown from docs.convex.dev, or the component's README at the pinned version. A general web search is the last resort, and its version counts as unverified.
When it matters, Claude checks the installed package's own exports and .d.ts files in node_modules, which SKILL.md calls the ground truth for your version. It cites the page and version it used, and hands the code back to convex-expert to write. The skill folder holds one file, SKILL.md.
Good for
- Convex developers who see errors from renamed or removed APIs
- Projects that use @convex-dev components with their own versions
- Claude Code, Cursor and Codex users who already run skills
Install convex-docs
Claude Code
- 1
Copy this prompt.
Install the convex-docs skill in Claude Code. Run this command: npx skills add https://github.com/convex/agent-skills --skill convex-docs --skill convex-expert Then check that it loaded and tell me how to use it.
- 2
Paste it into Claude Code. It shows the change and asks before running it.
Requires Node.js.
SKILL.md hands work to convex-expert, so the first command installs it too. Convex's docs say the skills CLI installs skills into .agents/skills/ in your project. The "All Convex skills" command installs every skill in the repo, which has 33 skill folders. One of them, convex-improve-convex-plugin, is listed in the Convex docs as sending your coding session's transcript to the Convex team. Run this skill with /convex-docs in Claude Code or $convex-docs in Codex, or let the agent pick it when the task fits.
Built from the package data we hold. Not yet tested by us.
What's in the skill
When it loads
Pull version-current Convex docs for the version this project uses — pin the installed version, fetch page-as-markdown or check node_modules types, freshness hierarchy — instead of writing a possibly-stale API from memory.
Sections in SKILL.md
- Workflow
- Rules
Key facts
- Installs on skills.sh
- 38,536 (Nov 2, 2026)
- GitHub stars
- 68 (Nov 2, 2026)
- Last commit to the repo
- Oct 29, 2026
- What installs
- 1 file: SKILL.md
- skills.sh audits
- Gen Agent Trust Hub: pass, Socket: pass, Snyk: warn
What it includes
Reads the installed convex version and the versions of @convex-dev components
SKILL.md suggests node -p with require of node_modules/convex/package.json, or reading package.json. The docs must match these versions.
Runs code ·
Pin the versionServed docs tool or MCP search first, then docs page as markdown, then web search
Page-as-markdown uses far fewer tokens than HTML. Web search results are treated as unverified.
Network ·
Freshness hierarchyReads node_modules exports and .d.ts files to confirm an API exists
SKILL.md calls the installed types the ground truth for your version, more authoritative than any doc page.
Files ·
Check the installed packageApplies the fetched signature or flag, cites page and version, hands code to convex-expert
This skill supplies the fresh fact. convex-expert supplies the idiom.
Use the fact narrowlyTreats a missing export as a currentness question, not a spelling guess
Claude re-pins the version, fetches the current API and corrects it.
Version-mismatch errors
From the official docs
Permissions
Low risk
Claude reads your package files and fetches Convex docs pages, so the main risk is acting on a wrong or unverified version. Prefer the installed package types when the answer matters.
What it can do
- Read your data
- Create and change things
- Delete things
- Read-only mode
Watch out for
It can fall back to general web search
SKILL.md allows web search as the last resort and says to treat the version it returns as unverified. Prefer the installed package types when the answer matters. github.com
Page content enters the conversation
Fetched docs text becomes part of what the assistant reads. SKILL.md names docs.convex.dev and a component README at its pinned version; the README host is not named. A web-search fallback can bring in other sites. github.com
Security advisories
No published security advisories as of Nov 2, 2026.
Technical details
| Turning on read-only | No read-only switch. Its steps are lookups, and the code it informs is written by convex-expert. |
|---|---|
| Talks to | docs.convex.dev |
| Scopes |
|
Questions
How do I install convex-docs?
Use the install box above. The first command also installs convex-expert, which SKILL.md hands the final code to. Run it with /convex-docs in Claude Code or $convex-docs in Codex.
What does it fetch, and from where?
Pages from docs.convex.dev, preferably as markdown, or a component's README at your pinned version. If it falls back to general web search, SKILL.md says to treat the result's version as unverified.
Do I need the Convex MCP server for it?
Not required. SKILL.md says to use a served docs tool or MCP search_convex_docs when one is available, and otherwise to fetch the docs page itself.
How is it different from convex-expert?
convex-docs finds the current fact for your version. convex-expert, per this skill's SKILL.md, writes the idiomatic code. This one is a freshness layer, not a replacement for the baked-in rules.
Is it safe?
It reads your package.json and node_modules and fetches pages from docs.convex.dev, or a component README at your pinned version. It bundles no scripts. SKILL.md hands the final code to convex-expert, and marks anything from a web-search fallback as unverified, so check those results.
Is it official?
Yes. It is in Convex's own agent-skills repo, and Convex's docs list it among the agent skills Convex provides.
Does it work in the Claude app?
The README and Convex docs name Claude Code, Cursor, VS Code with GitHub Copilot, Windsurf and Codex. They do not name the Claude app, and this skill works on a local project, so we list no Claude app install.
Information
updated Nov 2, 2026
- Repository
- convex/agent-skills
- Folder
skills/convex-docs
Sources
Docs, issue trackers and discussions this page is built from.
Show all 4Hide
- convex/agent-skills README · github.com
- Convex docs: Agent Skills · docs.convex.dev
- convex-docs SKILL.md · github.com
- convex-expert SKILL.md · github.com