About add-neon-docs
A skill that adds Neon documentation links to a project's AI documentation file. It is intended for projects using Neon and lets AI assistants reference topic-specific guidance without copying large documents into the project.
Key features
- 01Detects supported AI documentation files
- 02Prompts before making changes
- 03Adds links to a references section
- 04Creates CLAUDE.md when needed
Use cases
- 01Add Neon best-practice links after configuring Neon
- 02Keep AI project documentation linked to relevant Neon guidance
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ neondatabase/ ai-rules --skill add-neon-docsAfter installing, type/add-neon-docsin Claude Code to confirm it loaded.
Bundled filesinstall-knowledge.mdskill-knowledge-map.json
Details
From the project READMEAdd 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:
- Load metadata - Read skill information from
skill-knowledge-map.json - Detect documentation file - Find
CLAUDE.md,AGENTS.md, or Cursor rules files - Ask permission - Show what will be added and where
- Add references - Insert URLs in a "Resources & References" section
- 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 projectsAGENTS.md- Custom AI documentation files.cursor/README.mdor.cursor/rules.md- Cursor IDE projects- Creates
CLAUDE.mdif 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.mdis 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.