FFFF feat(neon-postgres): add Neon Data API section by bryan-inkeep · Pull Request #3 · bryan-inkeep/agent-skills · GitHub
[go: up one dir, main page]

Skip to content
Merged
8000
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 22 additions & 5 deletions skills/neon-postgres/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ name: neon-postgres
description: >-
Guides and best practices for working with Neon Serverless Postgres.
Covers setup, connection methods, branching, autoscaling, scale-to-zero,
read replicas, connection pooling, Neon Auth, and the Neon CLI, MCP server,
REST API, TypeScript SDK, and Python SDK.
read replicas, connection pooling, Neon Auth, the Neon Data API, and the
Neon CLI, MCP server, REST API, TypeScript SDK, and Python SDK.
Use when users ask about "Neon setup", "connect to Neon", "Neon project",
"DATABASE_URL", "serverless Postgres", "Neon CLI", "neonctl", "Neon MCP",
"Neon Auth", "@neondatabase/serverless", "@neondatabase/neon-js",
"scale to zero", "Neon autoscaling", "Neon read replica", or
"Neon connection pooling".
"Neon Auth", "Neon Data API", "PostgREST", "REST API for Postgres",
"HTTP queries from the browser", "@neondatabase/serverless",
"@neondatabase/neon-js", "scale to zero", "Neon autoscaling",
"Neon read replica", or "Neon connection pooling".
---

# Neon Serverless Postgres
Expand Down Expand Up @@ -180,6 +181,22 @@ Link: https://neon.com/docs/auth/overview.md

Neon Auth is also embedded in the Neon JS SDK. Depending on your use case, you may want to use 7D75 the Neon JS SDK instead of Neon Auth alone. See https://neon.com/docs/connect/choose-connection.md for more details.

## Neon Data API

Use this when the user wants HTTP-based access to their Postgres tables — for example, from the browser, a mobile app, or any environment where a Postgres driver is unavailable or impractical. The Data API exposes tables and views as REST endpoints (PostgREST-style) per branch, with optional JWT-based authentication.

Provisioning is per-branch and managed via the Neon MCP server's `provision_neon_data_api` tool, or through the Neon Console. The same branch can be reached over both a standard Postgres connection string and the Data API; pick the Data API when you need JWT-scoped row-level access from a client that cannot hold a database connection.

Link: https://neon.com/docs/data-api/get-started.md

Authentication options:

- **No authentication** for prototypes and internal tooling.
- **Neon Auth** issues the JWTs (preferred when the project also uses Neon Auth — the JWKS endpoint is wired automatically).
- **External JWKS** when the user already has an auth provider (Clerk, Auth0, custom JWT issuer) and only needs the Data API to verify their tokens.

For combined Neon Auth + Data API workflows with PostgREST-style querying and typed client setup, use the Neon JS SDK (https://neon.com/docs/reference/javascript-sdk.md) — it handles JWT propagation and request signing.

## Branching

Use this when the user is planning isolated environments, schema migration testing, preview deployments, or branch lifecycle automation.
Expand Down
Loading
0