---
name: mongodb-nuxt
description: "Provisions a MongoDB database for a Nuxt app with `npx extraorbital add mongodb` (no signup, no card) and wires it into Nuxt with `mongodb`. Use when a Nuxt project needs MongoDB, Mongo, a document database, MONGODB_URI or Mongoose, or when MONGODB_URI is missing or unset in .env."
---

# MongoDB in Nuxt

<!-- Generated from ExtraOrbital's service registry by `pnpm skills:build` in platform/app. Edit the generator, not this file. -->

ExtraOrbital provisions a MongoDB database in one command and writes the credentials into the project's env file. For anything this recipe does not cover, use the `extraorbital` skill or https://extraorbital.dev/llms.txt.

## 1. Provision

```bash
npx extraorbital add mongodb
```

Run it from the project root. It is idempotent (a second run returns the same resource) and writes to `.env.local` if the project has one, otherwise `.env`, keeping that file out of git. Add `--json` to parse the result; credential values are redacted there, and you should never print them either.

| Variable | |
| --- | --- |
| `MONGODB_URI` | Carries the user, the password, TLS and the one database they reach |

Free on the Prototype plan: 512 MB, shared RAM and vCPU.

## 2. Install the client

```bash
npm install mongodb
```

## 3. Connect

`nuxi dev` loads `.env` only. If ExtraOrbital wrote `.env.local`, start with `nuxi dev --dotenv .env.local`, or provision with `--env-file .env`.

**`server/utils/mongodb.ts`**

```ts
import { MongoClient } from "mongodb";

export const mongo = new MongoClient(process.env.MONGODB_URI!);
// The database named in the connection string: the only one the credentials reach.
export const mongoDb = mongo.db();
```

## 4. Use it

**`server/api/mongodb.get.ts`**

```ts
// `mongoDb` is auto-imported from server/utils/mongodb.ts.
export default defineEventHandler(async () => {
  await mongoDb.collection("events").insertOne({ type: "ping", at: new Date() });
  const events = await mongoDb.collection("events").countDocuments();
  return { events };
});
```

## 5. Verify

```bash
npx extraorbital list        # the resource is listed as active
npm run dev
curl http://localhost:3000/api/mongodb
```

A JSON answer means the credentials, the client and the route all work. Delete the route afterwards if the app does not need it.

## Pitfalls

- Call `db()` with no name: the user in `MONGODB_URI` is scoped to the database in the string.
- Create the client once, as here; the driver pools connections and connects lazily on the first command. With Mongoose, `mongoose.connect(MONGODB_URI)` takes the same string.
- Keep the module in `server/utils/`: Nitro auto-imports its exports into server routes and never ships them to the browser. Export names are global across `server/utils`, which is why they are specific.
- A production build does not read `.env`: set the variables on the host (`npx extraorbital push` for Vercel).
- Only `runtimeConfig.public` reaches the browser; never put a credential there.
- Exit code 3 means the account is past its free allowance: show the human the link the command printed and wait. Do not retry or work around it.

Docs: https://extraorbital.dev/docs/resources/mongo.md