How do I install the Nitro skill?

Run npx skillmds@latest add getsentry/nitro in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Nitro safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Nitro?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Nitro free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Sentry (@getsentry) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Nitro by getsentry — Agent Skill

Name: Nitro
Author: Sentry

Nitro

Build and deploy universal JavaScript servers with Nitro v3. Use when working with nitro.config.ts, defineNitroConfig, defineHandler, defineConfig, server.ts entry, filesystem routing, route rules, useStorage, defineCachedHandler, useDatabase, definePlugin, runtime hooks, Vercel/Cloudflare deployment, or migrating from Nitro v2/nitropack.

Sentry 95116e0 5 files · 58.2 KB Updated Sep 17, 2026 845 repo stars

File contents

Build, configure, and deploy Nitro v3 applications using correct APIs and patterns.

Step 1: Classify the request

Request type	Read first
API surface, handler signatures, imports, config options	`references/api-surface.md`
Setup, routing, caching, storage, plugins, frameworks, common patterns	`references/common-use-cases.md`
Build failures, runtime errors, deployment issues, migration from v2	`references/troubleshooting-workarounds.md`

Load only the reference(s) matching the request. If the task spans categories, load relevant files.

Step 2: Apply core guardrails

Import defineHandler from "nitro", not defineEventHandler (v2 API).
Import config helpers from subpaths: "nitro/config", "nitro/cache", "nitro/storage", "nitro/database", "nitro/runtime-config", "nitro/types".
Use web standard event.req (Request) for body/headers — not v2 utilities like readBody or getHeader.
Never return from middleware unless intentionally terminating the request.
Only GET/HEAD requests are cached by defineCachedHandler; other methods bypass automatically.
useDatabase and defineTask require experimental feature flags.
Use "nitro" package name, not "nitropack" (v2).

Step 3: Implement

For new projects, use defineConfig from "nitro" in nitro.config.ts or add nitro() plugin from "nitro/vite" to vite.config.ts.
For server entry, export a web-compatible fetch(Request): Response handler from server.ts, or use server.node.ts for Express/Fastify.
For filesystem routes, place handlers in routes/ or api/ with [param] for dynamic segments and .get.ts/.post.ts for method-specific routes.
For caching, use defineCachedHandler from "nitro/cache" with maxAge and swr options.
For storage, use useStorage(namespace) from "nitro/storage" and configure drivers via storage config.
For plugins, create files in plugins/ directory using definePlugin and hook into request, response, error, or close.
For deployment, set preset in config or use NITRO_PRESET env var; Vercel/Netlify/Cloudflare are auto-detected.

Step 4: Validate

Run nitro dev and verify routes respond correctly.
Run nitro build and check .output/server/ contains expected files.
For cached routes, verify cache headers (etag, cache-control) and 304 responses.
For storage, verify data persists across requests with configured driver.
For deployment, verify the preset produces correct output format.

Step 5: Troubleshoot

defineEventHandler is not defined → use defineHandler from "nitro" (v3 API).
Cannot find module 'nitropack' → rename to "nitro" in imports and package.json.
Route not matched → check file is in routes/ or api/, or verify routes config mapping.
Middleware returning responses unexpectedly → ensure middleware does not return a value.
For detailed diagnostics, read references/troubleshooting-workarounds.md.

---name: nitrodescription: Build and deploy universal JavaScript servers with Nitro v3. Use when working with nitro.config.ts, defineNitroConfig, defineHandler, defineConfig, server.ts entry, filesystem routing, route rules, useStorage, defineCachedHandler, useDatabase, definePlugin, runtime hooks, Vercel/Cloudflare deployment, or migrating from Nitro v2/nitropack.---Build, configure, and deploy Nitro v3 applications using correct APIs and patterns.## Step 1: Classify the request| Request type | Read first || ---------------------------------------------------------------------- | ------------------------------------------- || API surface, handler signatures, imports, config options | `references/api-surface.md` || Setup, routing, caching, storage, plugins, frameworks, common patterns | `references/common-use-cases.md` || Build failures, runtime errors, deployment issues, migration from v2 | `references/troubleshooting-workarounds.md` |Load only the reference(s) matching the request. If the task spans categories, load relevant files.## Step 2: Apply core guardrails1. Import `defineHandler` from `"nitro"`, not `defineEventHandler` (v2 API).2. Import config helpers from subpaths: `"nitro/config"`, `"nitro/cache"`, `"nitro/storage"`, `"nitro/database"`, `"nitro/runtime-config"`, `"nitro/types"`.3. Use web standard `event.req` (Request) for body/headers — not v2 utilities like `readBody` or `getHeader`.4. Never return from middleware unless intentionally terminating the request.5. Only `GET`/`HEAD` requests are cached by `defineCachedHandler`; other methods bypass automatically.6. `useDatabase` and `defineTask` require experimental feature flags.7. Use `"nitro"` package name, not `"nitropack"` (v2).## Step 3: Implement1. For new projects, use `defineConfig` from `"nitro"` in `nitro.config.ts` or add `nitro()` plugin from `"nitro/vite"` to `vite.config.ts`.2. For server entry, export a web-compatible `fetch(Request): Response` handler from `server.ts`, or use `server.node.ts` for Express/Fastify.3. For filesystem routes, place handlers in `routes/` or `api/` with `[param]` for dynamic segments and `.get.ts`/`.post.ts` for method-specific routes.4. For caching, use `defineCachedHandler` from `"nitro/cache"` with `maxAge` and `swr` options.5. For storage, use `useStorage(namespace)` from `"nitro/storage"` and configure drivers via `storage` config.6. For plugins, create files in `plugins/` directory using `definePlugin` and hook into `request`, `response`, `error`, or `close`.7. For deployment, set `preset` in config or use `NITRO_PRESET` env var; Vercel/Netlify/Cloudflare are auto-detected.## Step 4: Validate1. Run `nitro dev` and verify routes respond correctly.2. Run `nitro build` and check `.output/server/` contains expected files.3. For cached routes, verify cache headers (`etag`, `cache-control`) and 304 responses.4. For storage, verify data persists across requests with configured driver.5. For deployment, verify the preset produces correct output format.## Step 5: Troubleshoot1. `defineEventHandler is not defined` → use `defineHandler` from `"nitro"` (v3 API).2. `Cannot find module 'nitropack'` → rename to `"nitro"` in imports and package.json.3. Route not matched → check file is in `routes/` or `api/`, or verify `routes` config mapping.4. Middleware returning responses unexpectedly → ensure middleware does not return a value.5. For detailed diagnostics, read `references/troubleshooting-workarounds.md`.

Frequently asked questions