convex-docs
Pull version-current Convex docs for the version this project uses
by get-convexFree
Description
convex-docs is an agent skill that pulls up-to-date Convex documentation for the exact version a project uses. It exists because the knowledge built into an agent can go stale, for example when a component gains a new export, a command-line flag changes, or an API is renamed between versions. The skill's first step is to pin the version: it reads the installed convex version from node_modules or package.json, along with the versions of any @convex-dev components in use, because mismatched versions are a major source of wrong code. It then follows a freshness order. If a documentation tool or MCP search is available, it uses that, since it returns version-scoped answers. Otherwise it fetches the specific docs page as markdown, or the component's README at the pinned version. Only after that does it fall back to a general web search, and it treats any answer from there as unverified. For a component export it is unsure of, it can check the installed type declarations, which are the ground truth for that version. The fetched fact is then applied narrowly, and the code is handed to convex-expert to write. It is part of the get-convex agent-skills repository and is added to a compatible agent with the skills command. Its audits show Gen Agent Trust Hub and Socket passed, with Snyk showing a warning.…
Highlights
- Pins the installed Convex and component versions
- Fetches version-matched docs as markdown
- Checks installed type declarations
- Falls back to web search only last
Ratings & Reviews
No ratings yet
Be the first to rate convex-docs.
People also visit
architecture-decision-records
Capture architectural decisions as numbered ADR markdown files in docs/adr/
brand-discovery
Run a structured, resumable multi-session brand identity interview across 8
codebase-onboarding
Analyze an unfamiliar codebase and generate a structured onboarding guide
convex-docs FAQ
What does convex-docs do?
It fetches Convex documentation for the version your project uses, so the agent does not write APIs from stale memory.
How does it pick the version?
It reads the installed convex version and the versions of any @convex-dev components from the project.
Where does it look first?
A documentation or MCP search tool if one is available, then the docs page as markdown, and only then a general web search.
How do I install it?
Run: npx skills add https://github.com/get-convex/agent-skills --skill convex-docs
What security audits has it passed?
Gen Agent Trust Hub and Socket passed. Snyk shows a warning.
What are the best convex-docs alternatives?
Popular alternatives to convex-docs include convex-explain-app, research and architecture-decision-records. See all convex-docs alternatives