convex-docs

convex-docs is a command for coding agents from get-convex/convex-agent-plugins. It costs 43 tokens per session (718 once invoked), scanned A, original, MIT.

A workflow for checking the current Convex documentation for the exact version installed in a project. Convex is a backend platform, and version-specific documentation helps account for changed APIs and commands.

In plain words
What is it for?
Use it when adding unfamiliar Convex APIs, checking command options, or verifying features in Convex components.
Why use it?
It prevents code from relying on outdated examples or documentation that does not match the project's installed packages.

Command

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/get-convex/convex-agent-plugins/convex-docs
Clone the repo
git clone --depth 1 https://github.com/get-convex/convex-agent-plugins

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for convex-docs

README.md
[![agentmods](https://agentmods.dev/badge/commands/get-convex/convex-agent-plugins/convex-docs.svg)](https://agentmods.dev/commands/get-convex/convex-agent-plugins/convex-docs)
Your own site
<a href="https://agentmods.dev/commands/get-convex/convex-agent-plugins/convex-docs"><img src="https://agentmods.dev/badge/commands/get-convex/convex-agent-plugins/convex-docs.svg" alt="Measured on agentmods" height="20"></a>
Per session 43 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 718 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00043 $0.00718
Opus 5 $0.00022 $0.00359
Sonnet 5 $0.00009 $0.00144
Haiku 4.5 $0.00004 $0.00072

Measured 4d ago against content hash 8bf5fc76b1bd, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

convex-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 4d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

commands/convex-docs.md · 27 lines

How it starts

The opening of the file, as written. The whole thing — 27 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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.

Steps

  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.

Read the full file on GitHub · 27 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 4d ago First seen · 27 lines · 43 tokens per session scan A 8bf5fc76b1bd

Subscribe to this mod's changes

convex-docs is a command published in the GitHub repository get-convex/convex-agent-plugins (112 stars, last pushed 6d ago), licensed MIT. It adds 43 tokens to every session and 718 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.