using-neon
Guides and best practices for working with Neon Serverless Postgres. Covers getting started, local development with Neon, choosing a connection method, Neon features, authentication (@neondatabase/auth), PostgREST-style data API (@neondatabase/neon-js), Neon CLI, and Neon's Platform API/SDKs. Use for any Neon-related questions.
- License 许可
- MIT
- 最近更新
- 2026-11-11
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- using-neon
- risk
- safe
- source
- https://github.com/neondatabase/agent-skills/tree/main/skills/neon-postgres
- description
- Guides and best practices for working with Neon Serverless Postgres. Covers getting started, local development with Neon, choosing a connection method, Neon features, authentication (@neondatabase/auth), PostgREST-style data API (@neondatabase/neon-js), Neon CLI, and Neon's Platform API/SDKs. Use for any Neon-related questions.
03 SKILL.md 正文
Neon Serverless Postgres
Neon is a serverless Postgres platform that separates compute and storage to offer autoscaling, branching, instant restore, and scale-to-zero. It's fully compatible with Postgres and works with any language, framework, or ORM that supports Postgres.
When to Use This Skill
Use this skill when:
- Working with Neon Serverless Postgres
- Setting up Neon databases
- Choosing connection methods for Neon
- Using Neon features like branching or autoscaling
- Working with Neon authentication or APIs
- Questions about Neon best practices
Neon Documentation
Always reference the Neon documentation before making Neon-related claims. The documentation is the source of truth for all Neon-related information.
Below you'll find a list of resources organized by area of concern. This is meant to support you find the right documentation pages to fetch and add a bit of additonal context.
You can use the curl commands to fetch the documentation page as markdown:
Documentation:
# Get list of all Neon docs
curl https://neon.com/llms.txt
# Fetch any doc page as markdown
curl -H "Accept: text/markdown" https://neon.com/docs/<path>
Don't guess docs pages. Use the llms.txt index to find the relevant URL or follow the links in the resources below.
Overview of Resources
Reference the appropriate resource file based on the user's needs:
Core Guides
| Area | Resource | When to Use |
|---|---|---|
| What is Neon | references/what-is-neon.md |
Understanding Neon concepts, architecture, core resources |
| Referencing Docs | references/referencing-docs.md |
Looking up official documentation, verifying information |
| Features | references/features.md |
Branching, autoscaling, scale-to-zero, instant restore |
| Getting Started | references/getting-started.md |
Setting up a project, connection strings, dependencies, schema |
| Connection Methods | references/connection-methods.md |
Choosing drivers based on platform and runtime |
| Developer Tools | references/devtools.md |
VSCode extension, MCP server, Neon CLI (neon init) |
Database Drivers & ORMs
HTTP/WebSocket queries for serverless/edge functions.
| Area | Resource | When to Use |
|---|---|---|
| Serverless Driver | references/neon-serverless.md |
@neondatabase/serverless - HTTP/WebSocket queries |
| Drizzle ORM | references/neon-drizzle.md |
Drizzle ORM integration with Neon |
Auth & Data API SDKs
Authentication and PostgREST-style data API for Neon.
| Area | Resource | When to Use |
|---|---|---|
| Neon Auth | references/neon-auth.md |
@neondatabase/auth - Authentication only |
| Neon JS SDK | references/neon-js.md |
@neondatabase/neon-js - Auth + Data API (PostgREST-style queries) |
Neon Platform API & CLI
Managing Neon resources programmatically via REST API, SDKs, or CLI.
| Area | Resource | When to Use |
|---|---|---|
| Platform API Overview | references/neon-platform-api.md |
Managing Neon resources via REST API |
| Neon CLI | references/neon-cli.md |
Terminal workflows, scripts, CI/CD pipelines |
| TypeScript SDK | references/neon-typescript-sdk.md |
@neondatabase/api-client |
| Python SDK | references/neon-python-sdk.md |
neon-api package |
04 同仓库更多 Skills
web-performance-optimization
Optimize website and web application performance including loading speed, Core Web Vitals, bundle size, caching strategies, and runtime performance
web-design-guidelines
Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "check accessibility", "audit design", "review UX", or "check my site against best practices".
wcag-audit-patterns
Conduct WCAG 2.2 accessibility audits with automated testing, manual verification, and remediation guidance. Use when auditing websites for accessibility, fixing WCAG violations, or implementing accessible design patterns.
ui-ux-pro-max
UI/UX design intelligence. 50 styles, 21 palettes, 50 font pairings, 20 charts, 9 stacks (React, Next.js, Vue, Svelte, SwiftUI, React Native, Flutter, Tailwind, shadcn/ui). Actions: plan, build, create, design, implement, review, fix, improve, optimize, enhance, refactor, check UI/UX code. Projects: website, landing page, dashboard, admin panel, e-commerce, SaaS, portfolio, blog, mobile app, .html, .tsx, .vue, .svelte. Elements: button, modal, navbar, sidebar, card, table, form, chart. Styles: glassmorphism, claymorphism, minimalism, brutalism, neumorphism, bento grid, dark mode, responsive, skeuomorphism, flat design. Topics: color palette, accessibility, animation, layout, typography, font pairing, spacing, hover, shadow, gradient. Integrations: shadcn/ui MCP for component search and examples.
stitch-ui-design
Expert guide for creating effective prompts for Google Stitch AI UI design tool. Use when user wants to design UI/UX in Stitch, create app interfaces, generate mobile/web designs, or needs help crafting Stitch prompts. Covers prompt structure, specificity techniques, iteration strategies, and design-to-code workflows for Stitch by Google.
scroll-experience
Expert in building immersive scroll-driven experiences - parallax storytelling, scroll animations, interactive narratives, and cinematic web experiences. Like NY Times interactives, Apple product pages, and award-winning web experiences. Makes websites feel like experiences, not just pages. Use when: scroll animation, parallax, scroll storytelling, interactive story, cinematic website.