add-neon-docs

作者: neondatabase

当用户要求添加关于Neon的文档、添加文档、添加参考资料或安装文档时,使用此技能。添加Neon最佳实践参考链接…

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.

来自 neondatabase 的更多技能

claimable-postgres
neondatabase
为本地开发、演示、原型设计和测试环境提供即时Postgres数据库。无需账户。除非认领到Neon账户,否则数据库将在72小时后过期。
neon
neondatabase
Neon平台概述,涵盖Postgres、Auth、Data API以及新服务:对象存储、计算函数和AI网关。当提到“Neon”时,用于概述如何与Neon协作及如何入门。否则,各项独立功能为触发点:“对象存储”或“S3兼容存储”、“无服务器函数”、“后台任务”或“在数据库附近运行代码”、“AI网关”、“LLM代理”、“模型路由”或“调用LLM”→...
apidatabasedevelopment
plugin-manager
neondatabase
管理此仓库在Cursor和Claude Code中的插件结构与配置。在创建、更新或审查插件文件夹时使用…
skill-creator
neondatabase
创建有效技能的指南。当用户想要创建新技能(或更新现有技能)以扩展Claude的功能时,应使用此技能。
using-neon
neondatabase
使用Neon Serverless Postgres的指南和最佳实践。涵盖入门、使用Neon进行本地开发、选择连接方法、Neon…
neon-js-react
neondatabase
在 React 应用(Vite、CRA)中设置完整的 Neon SDK,包含身份验证和数据库查询。创建类型化客户端、生成数据库类型并配置…
postgres-best-practices
neondatabase
使用Postgres的最佳实践和指南。涵盖模式设计、索引策略、查询优化、迁移以及常见陷阱。使用…
neon-postgres-egress-optimizer
neondatabase
指导用户诊断并修复导致其Postgres数据库产生过多数据传输(出站流量)的应用端查询模式。大多数高额出站流量账单源于应用程序获取的数据量超出实际使用量。