neon-plugin

[!IMPORTANT] This repository has been archived. The content has moved to neondatabase/agent-skills.

Agent Skills are now a specification supported by all major agents and coding editors, providing more capabilities than rule files. We created a new repository following the agent-skills pattern introduced by Vercel.

npx skills add neondatabase/agent-skills

Neon AI Development Toolkit

A comprehensive Claude Code plugin with AI context rules, guided skills, and resource management tools for building with Neon Postgres. Works with Claude Code, Cursor, and other AI-powered development tools.

What's Inside

For Claude Code Users

• Claude Code Plugin - The plugin itself, which includes 6 skills and MCP server integration
• Claude Code Skills - Interactive workflows with templates and automation scripts for Neon
• MCP Server Integration - Direct Neon resource management (projects, branches, databases)

For Cursor & Other AI Tools

• Portable .mdc Files - Standalone context rules that work anywhere
• Tool-Agnostic Format - Use with any AI assistant supporting custom rules

---

Quick Start

Claude Code

1. Add the Neon marketplace:

/plugin marketplace add neondatabase-labs/ai-rules

2. Install the plugin:

/plugin install neon-plugin@neon

3. Verify installation: Ask Claude Code: "which skills do you have access to?"

You should see the Neon skills listed.

4. Start using: Use natural language and skills activate automatically:

> Use the neon-drizzle skill to setup Drizzle ORM with Neon

Cursor

1. Create rules directory:

mkdir -p .cursor/rules

2. Copy desired .mdc files:

# Example: Copy Drizzle and Serverless rules
cp neon-drizzle.mdc .cursor/rules/
cp neon-serverless.mdc .cursor/rules/

3. Start coding: Cursor automatically applies these rules when you reference Neon.

Other AI Tools

Copy .mdc files to your AI tool's custom rules directory. The format is tool-agnostic and works with any AI assistant supporting context rules.

---

Skills Reference

Neon Drizzle - Setup Drizzle ORM with Neon

Complete workflow support for:

• New project setup
• Existing project integration
• Schema-only workflows

Includes:

• Schema generation utilities
• Migration scripts (db:generate, db:migrate, db:push, db:studio)
• HTTP and WebSocket adapter templates
• Technical references for adapters, migrations, and query patterns

Guides:

• guides/new-project.md - Starting from scratch
• guides/existing-project.md - Adding to existing codebase
• guides/schema-only.md - Schema-first development
• guides/troubleshooting.md - Common issues and solutions

Neon Serverless - Configure serverless database connections

Templates for:

• HTTP connections (single-query operations)
• WebSocket pooling (long-running processes)
• Connection validation utilities

Neon Toolkit - Manage ephemeral databases

Perfect for testing and CI/CD:

• Create temporary databases
• Run tests in isolation
• Clean up automatically

Includes:

• create-ephemeral-db.ts - Database creation
• destroy-ephemeral-db.ts - Cleanup automation
• Workflow templates

Neon Auth - Integrate Neon Auth authentication

Complete authentication setup with @neondatabase/auth:

• Next.js App Router integration
• React SPA setup
• Auth client configuration templates
• API route handlers

Guides:

• guides/nextjs-setup.md - Next.js App Router workflow
• guides/react-spa-setup.md - React SPA workflow

Neon JS - Full Neon JS SDK integration

Unified SDK setup with @neondatabase/neon-js:

• Combined auth + data API client
• Type-safe database operations
• Theming and customization

Guides:

• guides/setup.md - Complete setup workflow

Add Neon Docs - Install documentation references

Adds Neon best practices to your project's AI configuration:

• CLAUDE.md
• AGENTS.md
• Cursor rules files

---

Testing & Quality Assurance

Our skills are tested with automated evaluations to ensure reliability and quality.