AIPM
Theme

AIPM package

Convex Docs

@convex/convex-docs@1.0.0

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…

Scanned · no issues · Oct 29, 2026

GitHub stars: ★ 69

LinkedInPost

Install Skill

Pins this version in aipm.package.json and aipm-lock.json.

aipm add @convex/convex-docs@1.0.0

Without project tracking

Writes the skill files only. Add --no-init to skip aipm.package.json and the lockfile.

aipm add @convex/convex-docs@1.0.0 --no-init

How to use

Install the skill above, then run this in your AI tool:

/convex-docs <your description>

About

<!-- GENERATED from convex-agents content/capabilities/convex-docs.json — do not edit by hand. -->

Source

What gets added to your project

Preview every file this package writes on install before you run the command above.

Summary

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.

Skill instructions

<!-- GENERATED from convex-agents content/capabilities/convex-docs.json — do not edit by hand. -->

Pull version-current Convex docs

convex-expert carries baked, plugin-versioned knowledge — excellent for stable idioms, but it goes stale exactly where it hurts: a component that gained a new export, a CLI flag that changed, an API renamed between versions. This capability is the freshness discipline layered on top: pin to the project's real version, fetch the live page cheaply as markdown, and never write an unfamiliar API from memory when the current source is one fetch away.

Workflow

  1. PIN the version: read the installed convex version (node -p "require('./node_modules/convex/package.json').version" or package.json), and the versions of any @convex-dev/* components in play. The docs you trust must match THESE versions — version skew is the single largest source of wrong Convex code.
  2. FRESHNESS HIERARCHY (cheapest-correct first, the Supabase-taught order): (a) if a served docs tool / MCP search_convex_docs is available, use it (it returns version-scoped, reranked answers sized to the context window); (b) else fetch the specific docs page as MARKDOWN — request docs.convex.dev/<path> and prefer a .md/markdown form when the site serves one (far fewer tokens than HTML), or the component's README at the pinned version; (c) only then fall back to a general web search, and treat its version as unverified. Do NOT skip to writing the API from memory when currentness is in doubt.
  3. VERIFY against the installed package when it matters: for a component export you're unsure exists, check node_modules/@convex-dev/<x>/ (its package.json exports, its .d.ts) — the installed types are the ground truth for THIS version, more authoritative than any doc.
  4. USE the fetched fact narrowly: apply the current signature/flag, cite where it came from (page + version), and hand the actual code back to convex-expert to write idiomatically. convex-docs supplies the fresh fact; convex-expert supplies the idiom.
  5. On a version-mismatch build error (an export/flag that 'should' exist but doesn't): treat it as a currentness question — pin the version, fetch the current API, and correct — rather than guessing a different spelling.

Rules

  • Never write an unfamiliar or possibly-renamed Convex/component API from model memory when currentness is in doubt — pin the version and fetch the current source first.
  • The installed package's own exports/.d.ts in node_modules is the ground truth for this version — more authoritative than any doc page.
  • Follow the freshness hierarchy: served docs tool → page-as-markdown / pinned README → general web (unverified) — cheapest-correct first, fewest tokens.
  • Prefer markdown over HTML doc pages — far fewer tokens for the same content.
  • Supply the fresh FACT; hand idiomatic code back to convex-expert. This is a freshness layer, not a replacement for the baked knowledge.
  • A version-mismatch build error is a currentness question, not a spelling guess — re-pin and re-fetch.

Loading package files…

Share this package

Add an Install with AIPM badge

Add this badge to a GitHub README so readers can open the package page and install the same version.

Install with AIPM
[![Install with AIPM](https://www.aipm-registry.com/install-with-aipm.svg)](https://www.aipm-registry.com/skills/convex/convex-docs/1.0.0?utm_source=github&utm_medium=readme&utm_campaign=package_badge)

Publisher

Convex

This imported publisher has not claimed its AIPM account. A connected account confirms account control, but it does not guarantee that a package is safe.

AI assistant context

What this skill is for

@convex/convex-docs@1.0.0 is an AIPM skill package for All tools. Use it when a project needs the reusable AI behavior described as: 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.

Install
aipm add @convex/convex-docs@1.0.0
Use after install
/convex-docs <your description>

Tool targets

Install command by target

Add --no-init to any of these when you want the skill files without aipm.package.json or aipm-lock.json.

cursor

Run this variant when you want to install the package into cursor.

aipm add @convex/convex-docs@1.0.0 --target cursor --ci

claude

Run this variant when you want to install the package into claude.

aipm add @convex/convex-docs@1.0.0 --target claude --ci

Discussion

Comments (0)

Loading comments…

Keep exploring

Convex/convex-explain-app

Explain an existing Convex app — data model + relationships, public vs internal functions, auth/ownership model, components, a request→data flow — read from the schema and function surface. Read-only.

Published by Convex

skillScanned · no issues★ 69Imported · UnverifiedAll toolsNov 19, 2026, 1:09 AM2.45 KBApache-2.0

Convex/convex-suggest

Suggest the matching Convex component when the user hand-rolls a pattern it already solves (crons, sharded-counter, rate-limiter, storage, search, presence, workflow, RAG, prosemirror-sync). Passive — suggest after the task, never interr...

Published by Convex

skillScanned · no issues★ 69Imported · UnverifiedAll toolsNov 19, 2026, 1:09 AM1.58 KBApache-2.0

Convex/convex-domains

Point a domain you already own at your Convex app (DNS records, custom-domain attach, auth-origin rebind).

Published by Convex

skillScanned · no issues★ 69Imported · UnverifiedAll toolsNov 19, 2026, 1:09 AM1.60 KBApache-2.0

Package FAQ

Install and compatibility

How to install
Run aipm add @convex/convex-docs@1.0.0 in a project that has AIPM initialized.
Supported tools
@convex/convex-docs@1.0.0 supports All tools.

Before installing

AIPM skills can add files to your project. Review the package name, target, description, license, and publisher before installing. Use a clean branch when trying a new skill.