neon-plugin/skills/add-neon-docs/SKILL.md
Use this skill when the user asks to add documentation, add docs, add references, or install documentation about Neon. Adds Neon best practices reference links to project AI documentation (CLAUDE.md, AGENTS.md, or Cursor rules). Does not install packages or modify code.
npx skillsauth add neondatabase/ai-rules add-neon-docsInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
This skill adds reference links to Neon documentation and best practices in your project's AI documentation file, enabling AI assistants to quickly access Neon-specific patterns and guidelines without cluttering your project with large documentation files.
This skill follows a simple workflow:
skill-knowledge-map.jsonCLAUDE.md, AGENTS.md, or Cursor rules filesFor detailed workflow steps, see install-knowledge.md.
Optional. Specifies which skill documentation to install (e.g., "neon-drizzle"). If not provided, you'll be prompted to choose from available skills defined in skill-knowledge-map.json.
Called from another skill:
Execute the add-neon-docs skill with SKILL_NAME="neon-drizzle"
Called directly by user:
References are added to a "Resources & References" section in your AI documentation file:
## Resources & References
- **Neon and Drizzle ORM best practices**: https://raw.githubusercontent.com/neondatabase-labs/ai-rules/main/neon-drizzle.mdc
- **Serverless connection patterns**: https://raw.githubusercontent.com/neondatabase-labs/ai-rules/main/neon-serverless.mdc
CLAUDE.md - Most common for Claude Code projectsAGENTS.md - Custom AI documentation files.cursor/README.md or .cursor/rules.md - Cursor IDE projectsCLAUDE.md if none existCLAUDE.md is created with referencesFor complete implementation details:
install-knowledge.md - Step-by-step agent workflow with error handlingskill-knowledge-map.json - Skill definitions and reference URLsNow I'll execute the installation workflow for you.
Parameter received: SKILL_NAME = ${SKILL_NAME || "not provided - will ask user"}
Execute install-knowledge.md with the specified SKILL_NAME.
tools
Creates and manages ephemeral Neon databases for testing, CI/CD pipelines, and isolated development environments. Use when building temporary databases for automated tests or rapid prototyping.
tools
Configures Neon Serverless Driver for Next.js, Vercel Edge Functions, AWS Lambda, and other serverless environments. Installs @neondatabase/serverless, sets up environment variables, and creates working API route examples with TypeScript types. Use when users need to connect their application to Neon, fetch or query data from a Neon database, integrate Neon with Next.js or serverless frameworks, or set up database access in edge/serverless environments where traditional PostgreSQL clients don't work.
tools
Sets up the full Neon JS SDK with unified auth and PostgREST-style database queries. Configures auth client, data client, and type generation. Use when building apps that need both authentication and database access in one SDK.
development
Creates a fully functional Drizzle ORM setup with a provisioned Neon database. Installs dependencies, provisions database credentials, configures connections, generates schemas, and runs migrations. Results in working code that can immediately connect to and query the database. Use when creating new projects with Drizzle, adding ORM to existing applications, or modifying database schemas.