neon

Name: neon
Author: neondatabase

11kinstalls12forks

How to install neon?

neondatabase/agent-skills/neon

$npx -y skills add neondatabase/agent-skills --skill neon

Installs into the current project.

Summary

Overview of the Neon platform for apps and agents, spanning Postgres, Auth, the Data API, and the new services: Object Storage, Compute Functions, and AI Gateway. Use when "Neon" is mentioned, or when any of its individual capabilities are the trigger: "object storage" or "S3", "

Files · 1

View on GitHub

SKILL.md

1	# Neon
2
3	Important: Neon is no longer just a Serverless Postgres provider. Neon is the backend for apps and agents with Serverless Postgres, Auth, Functions, Object Storage, and an AI Gateway: instant, branchable, serverless.
4
5	Use this skill as the starting point for anything Neon: get an overview of its capabilities, find your way around the Neon agent skills and documentation, and follow best practices for getting started and for branch-first development workflows.
6
7	## Platform Services
8
9	Neon bundles several backend primitives for building apps and agents that all branch together with your project:
10
11	- Postgres — Serverless Postgres that scales and branches with your app. _Generally available._
12	- Auth — Managed authentication with users and sessions stored in Postgres. _Generally available._
13	- Object Storage — S3-compatible object storage that branches with your projects. _Public beta._
14	- Functions — Long-running serverless functions - Neon's compute offering - running close to your database — for WebSocket servers, long agent HTTP streams, APIs, and server-sent event servers. _Public beta._
15	- AI Gateway — One API for all frontier and open-source models, with routing, logging, and cost controls, powered by Databricks. _Public beta._
16
17	### Public Beta Service Availability
18
19	Object Storage, Functions, and AI Gateway are in public beta.
20
21	Beta access features are only available on net-new projects created in the `us-east-2` region; they cannot be enabled on existing projects for now. Before guiding a user through any of these services, confirm they are working with a new project in `us-east-2`. If not, they will need to create a new project in that region.
22
23	## Architecture: how Neon fits
24
25	Neon is not a place to host your full-stack app — it's backend primitives (Postgres, Auth, Object Storage, Functions, AI Gateway) that compose with the application platform you already use. Host the app on Vercel (or Netlify, or another frontend/app host); Neon is the backend it talks to.
26
27	A typical setup:
28
29	- Full-stack app on Vercel (or Netlify) — e.g. Next.js or TanStack Start. It owns your UI and auth (e.g. Neon Auth) and talks directly to your Neon Postgres database and Neon Object Storage.
30	- Reach for Neon Functions when you outgrow the host's limits — a WebSocket or SSE server, or long-running agents that risk timing out on short, lambda-style serverless. Run that one piece on a Neon Function, next to your data.
31
32	You can also move your whole backend control plane onto Neon Functions. This is especially useful when the frontend is client-only rather than full-stack — TanStack Router, React Router in client mode, and similar SPAs hosted on Vercel or Netlify. The client talks directly to Neon Functions, where you build REST APIs and request/response agents, host MCP servers, and run anything stateful or that should live close to Postgres and Object Storage. Secure these functions like any standalone REST API — verify a JWT or API key at the top of each handler (see the `neon-functions` skill).
33
34	Because Functions are just your backend, they compose with a full-stack app too: if you already have a backend (Next.js route handlers, etc.), Neon Functions sit alongside it, and you can move pieces between the two — e.g. relocate a long-running agent or a stateful WebSocket server off your host onto a Function when it needs more runtime.
35
36	## Neon Documentation
37
38	The Neon documentation is the source of truth for all Neon-related information. Always verify claims against the official docs before responding. Neon features and APIs evolve, so prefer fetching current docs over relying on training data.
39
40	### Fetching Docs as Markdown
41
42	Any Neon doc page can be fetched as markdown in two ways:
43
44	1. Append `.md` to the URL (simplest): https://neon.com/docs/introduction/branching.md
45	2. Request `text/markdown` on the standard URL: `curl -H "Accept: text/markdown" https://neon.com/docs/introduction/branching`
46
47	Both return the same markdown content. Use whichever method your tools support.
48
49	### Finding the Right Page
50
51	The docs index lists every available page with its URL and a short description:
52
53	```
54	https://neon.com/docs/llms.txt
55	```
56
57	Common doc URLs are organized in the topic links below. If you need a page not listed here, search the docs index: https://neon.com/docs/llms.txt. Don't guess URLs.
58
59	## Choosing the Right Skill
60
61	- Working with the database, connections, schema, queries, autoscaling, or the CLI/MCP/API → `neon-postgres`.
62	- Choosing or c

People who liked this also viewed

6 picks

Type

neon

11kinstalls12forks

View on GitHub

How to install neon?

neondatabase/agent-skills/neon

$npx -y skills add neondatabase/agent-skills --skill neon

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# Neon
2
3	Important: Neon is no longer just a Serverless Postgres provider. Neon is the backend for apps and agents with Serverless Postgres, Auth, Functions, Object Storage, and an AI Gateway: instant, branchable, serverless.
4
5	Use this skill as the starting point for anything Neon: get an overview of its capabilities, find your way around the Neon agent skills and documentation, and follow best practices for getting started and for branch-first development workflows.
6
7	## Platform Services
8
9	Neon bundles several backend primitives for building apps and agents that all branch together with your project:
10
11	- Postgres — Serverless Postgres that scales and branches with your app. _Generally available._
12	- Auth — Managed authentication with users and sessions stored in Postgres. _Generally available._
13	- Object Storage — S3-compatible object storage that branches with your projects. _Public beta._
14	- Functions — Long-running serverless functions - Neon's compute offering - running close to your database — for WebSocket servers, long agent HTTP streams, APIs, and server-sent event servers. _Public beta._
15	- AI Gateway — One API for all frontier and open-source models, with routing, logging, and cost controls, powered by Databricks. _Public beta._
16
17	### Public Beta Service Availability
18
19	Object Storage, Functions, and AI Gateway are in public beta.
20
21	Beta access features are only available on net-new projects created in the `us-east-2` region; they cannot be enabled on existing projects for now. Before guiding a user through any of these services, confirm they are working with a new project in `us-east-2`. If not, they will need to create a new project in that region.
22
23	## Architecture: how Neon fits
24
25	Neon is not a place to host your full-stack app — it's backend primitives (Postgres, Auth, Object Storage, Functions, AI Gateway) that compose with the application platform you already use. Host the app on Vercel (or Netlify, or another frontend/app host); Neon is the backend it talks to.
26
27	A typical setup:
28
29	- Full-stack app on Vercel (or Netlify) — e.g. Next.js or TanStack Start. It owns your UI and auth (e.g. Neon Auth) and talks directly to your Neon Postgres database and Neon Object Storage.
30	- Reach for Neon Functions when you outgrow the host's limits — a WebSocket or SSE server, or long-running agents that risk timing out on short, lambda-style serverless. Run that one piece on a Neon Function, next to your data.
31
32	You can also move your whole backend control plane onto Neon Functions. This is especially useful when the frontend is client-only rather than full-stack — TanStack Router, React Router in client mode, and similar SPAs hosted on Vercel or Netlify. The client talks directly to Neon Functions, where you build REST APIs and request/response agents, host MCP servers, and run anything stateful or that should live close to Postgres and Object Storage. Secure these functions like any standalone REST API — verify a JWT or API key at the top of each handler (see the `neon-functions` skill).
33
34	Because Functions are just your backend, they compose with a full-stack app too: if you already have a backend (Next.js route handlers, etc.), Neon Functions sit alongside it, and you can move pieces between the two — e.g. relocate a long-running agent or a stateful WebSocket server off your host onto a Function when it needs more runtime.
35
36	## Neon Documentation
37
38	The Neon documentation is the source of truth for all Neon-related information. Always verify claims against the official docs before responding. Neon features and APIs evolve, so prefer fetching current docs over relying on training data.
39
40	### Fetching Docs as Markdown
41
42	Any Neon doc page can be fetched as markdown in two ways:
43
44	1. Append `.md` to the URL (simplest): https://neon.com/docs/introduction/branching.md
45	2. Request `text/markdown` on the standard URL: `curl -H "Accept: text/markdown" https://neon.com/docs/introduction/branching`
46
47	Both return the same markdown content. Use whichever method your tools support.
48
49	### Finding the Right Page
50
51	The docs index lists every available page with its URL and a short description:
52
53	```
54	https://neon.com/docs/llms.txt
55	```
56
57	Common doc URLs are organized in the topic links below. If you need a page not listed here, search the docs index: https://neon.com/docs/llms.txt. Don't guess URLs.
58
59	## Choosing the Right Skill
60
61	- Working with the database, connections, schema, queries, autoscaling, or the CLI/MCP/API → `neon-postgres`.
62	- Choosing or c

People who liked this also viewed

6 picks

Type