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. Add a mutation.
  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.

Use a coding agent

A coding agent is a development tool that can inspect and change your project. After installation, copy this prompt into your coding agent:

Add Better Convex to this application using the smallest suitable Nuxt, Vue,
or MCP package. Read the project's existing instructions first. Resolve the
installed @lupinum/better-convex-*/agent-docs export from this application's
directory and read its starting pages. Use the installed version's examples
and public types. Preserve existing authorization, routes, conventions, and
AGENTS.md instructions. Convex functions remain the source of truth for
authorization; do not move that rule into client state, Nuxt middleware, or MCP
transport. Add or update one short Better Convex pointer in AGENTS.md if the
project allows it; do not duplicate the documentation. If the file is absent,
create only that pointer. Report missing guidance. Verify the affected type,
build, runtime, authentication, and disposal boundaries.

If the installed package has no agent-docs export, read its packaged README and types. Use documentation from the matching source tag when more detail is needed. Installing or updating the package does not edit project instructions. The pointer resolves the installed package, so upgrades and rollbacks select the matching documentation without copying it into your application.

Start from an example

The repository has four starters. Start with public or mcp-oauth-agent:

  • starters/public: a public live todo app without sign-in.
  • 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.