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 資料庫,適用於本地開發、展示、原型設計與測試環境。無需註冊帳號。資料庫在 72 小時後到期,除非認領至 Neon 帳號。
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 資料庫傳輸過多資料(出口流量)。大多數高額出口帳單來自應用程式擷取超出實際使用的資料。