add-neon-docs

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…

npx skills add https://github.com/neondatabase/ai-rules --skill add-neon-docs

Add Neon Knowledge References to Project

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.

How It Works

This skill follows a simple workflow:

  1. Load metadata - Read skill information from skill-knowledge-map.json
  2. Detect documentation file - Find CLAUDE.md, AGENTS.md, or Cursor rules files
  3. Ask permission - Show what will be added and where
  4. Add references - Insert URLs in a "Resources & References" section
  5. Report completion - Confirm successful installation

For detailed workflow steps, see install-knowledge.md.

Parameters

SKILL_NAME Parameter

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.

Usage Examples

Called from another skill:

Execute the add-neon-docs skill with SKILL_NAME="neon-drizzle"

Called directly by user:

  • "Add neon drizzle knowledge to my project"
  • "Install neon serverless documentation"
  • "Set up Neon best practices for my AI assistant"

What Gets Added

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

Target Files (in priority order):

  • CLAUDE.md - Most common for Claude Code projects
  • AGENTS.md - Custom AI documentation files
  • .cursor/README.md or .cursor/rules.md - Cursor IDE projects
  • Creates CLAUDE.md if none exist

Behavior:

  • Existing "Resources & References" sections: New links are appended
  • No existing section: Section is created at end of file
  • No documentation file: CLAUDE.md is created with references

Related Skills

  • neon-drizzle - Sets up Drizzle ORM, then offers this skill
  • neon-serverless - Sets up connections, then offers this skill
  • neon-toolkit - Sets up ephemeral databases, then offers this skill

Workflow Reference

For complete implementation details:

  • Workflow: install-knowledge.md - Step-by-step agent workflow with error handling
  • Metadata: skill-knowledge-map.json - Skill definitions and reference URLs

Workflow Implementation

Now 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.

Thêm skills từ neondatabase

add-neon-docs
neondatabase
Sử dụng kỹ năng này khi người dùng yêu cầu thêm tài liệu, thêm tài liệu hướng dẫn, thêm tài liệu tham khảo, hoặc cài đặt tài liệu về Neon. Thêm các liên kết tham khảo thực hành tốt nhất của Neon…
official
neon-auth
neondatabase
Thiết lập Neon Auth cho ứng dụng của bạn. Cấu hình xác thực, tạo các route xác thực và tạo các thành phần giao diện. Sử dụng khi thêm xác thực vào Next.js,…
official
neon-drizzle
neondatabase
Tạo một thiết lập Drizzle ORM đầy đủ chức năng với cơ sở dữ liệu Neon đã được cấp phát. Cài đặt các phụ thuộc, cấp phát thông tin xác thực cơ sở dữ liệu, cấu hình kết nối,…
official
neon-js
neondatabase
Thiết lập toàn bộ Neon JS SDK với xác thực hợp nhất và truy vấn cơ sở dữ liệu kiểu PostgREST. Cấu hình máy khách xác thực, máy khách dữ liệu và sinh kiểu. Sử dụng khi…
official
neon-serverless
neondatabase
Cấu hình Neon Serverless Driver cho Next.js, Vercel Edge Functions, AWS Lambda và các môi trường serverless khác. Cài đặt @neondatabase/serverless, thiết lập…
official
neon-toolkit
neondatabase
Tạo và quản lý các cơ sở dữ liệu Neon tạm thời cho mục đích kiểm thử, đường ống CI/CD và môi trường phát triển biệt lập. Sử dụng khi xây dựng cơ sở dữ liệu tạm thời cho…
official
logging-best-practices
neondatabase
Các phương pháp ghi log tốt nhất tập trung vào các sự kiện rộng (dòng log chuẩn) để hỗ trợ gỡ lỗi và phân tích mạnh mẽ
official
skill-creator
neondatabase
Hướng dẫn tạo kỹ năng hiệu quả. Kỹ năng này nên được sử dụng khi người dùng muốn tạo một kỹ năng mới (hoặc cập nhật kỹ năng hiện có) để mở rộng khả năng của Claude…
official