Skip to main content

Choose your path

Pick the quick start for Nuxt, plain Vue, Better Auth, or MCP.

Pick the path that matches your application.

New Nuxt app

Follow the quick start in order:

  1. Install the module.
  2. Build a live page.
  3. Complete and delete.
  4. Add authentication.
  5. Protect data and routes.
  6. Next steps.

Steps 1 to 3 do not use authentication. Stop after step 3 if your app has no sign-in.

Existing Nuxt and Convex app

Start with installation. Then move one page at a time to the module composables.

Remove your old Convex client plugin when the last page uses the module. Do not run two Convex clients side by side. They create duplicate subscriptions and conflicting auth state.

Plain Vue or Vite

Use @lupinum/better-convex-vue when you do not use Nuxt. It has the same browser composables. It has no server rendering, server routes, or Better Auth setup.

ChatGPT and Claude through MCP

Complete the Nuxt quick start with authentication first. Then follow:

  1. Add MCP to your application.
  2. Connect ChatGPT and Claude.
  3. Optional: show a card for a tool with MCP Apps.

Operations, policy and agents

To check one policy and one row rule in every Convex function, and to turn those functions into tools with approvals, start with Start here.

Use a coding agent

A coding agent is a development tool that can inspect and change your project. Every Better Convex package contains documentation for coding agents that matches the installed version: dist/agent/AGENTS.md, also exported as <package>/agent-docs. It starts with a task index and the rules that agents most often get wrong. The "Agent setup" section of each package README says how to point your project's AGENTS.md at it.

To add Better Convex to an application, give your agent this task:

Add Better Convex to this application. Install @lupinum/better-convex-nuxt
(or @lupinum/better-convex-vue for Vue without Nuxt). Set it up for coding
agents as described under "Agent setup" in the package README. Then read
node_modules/<package>/dist/agent/AGENTS.md and follow its "Start here" table.
Finish with the "Check your setup" steps of the Installation page.

Start from an example

The repository has four starters. Start with tutorial, or with mcp-oauth-agent for MCP:

  • starters/tutorial: the finished app of the quick start: a live todo list with email-code sign-in and an owner on each todo.
  • starters/mcp-oauth-agent: Better Auth, OAuth, and MCP together.
  • starters/team: a team app with the Better Auth organization plugin, roles, and teams. Use it as the reference for organization access rules.
  • starters/agency: an app that manages client workspaces and stores the access rules in its own Convex tables.