add-neon-docs について
Neon のドキュメントへのリンクをプロジェクトの AI ドキュメントに追加するスキルです。大きな文書をプロジェクトに複製せず、AI アシスタントがトピック別のガイドを参照できます。
主な機能
- 01対応する AI ドキュメントファイルの検出
- 02変更前の確認
- 03参考資料セクションへのリンク追加
- 04必要に応じた CLAUDE.md の作成
活用シーン
- 01Neon の設定後にベストプラクティスへのリンクを追加
- 02AI プロジェクト文書から関連 Neon ガイドを参照
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ neondatabase/ ai-rules --skill add-neon-docsインストール後、Claude Code で/add-neon-docsを入力して読み込まれたか確認します。
同梱ファイルinstall-knowledge.mdskill-knowledge-map.json
詳細
プロジェクトに Neon のナレッジ参照を追加する
このスキルは、Neon のドキュメントとベストプラクティスへの参照リンクを、プロジェクトの AI ドキュメントファイルに追加します。プロジェクトに大きなドキュメントファイルを置かずに、AI アシスタントが Neon 固有のパターンやガイドラインにすばやくアクセスできるようになります。
仕組み
このスキルは、次のシンプルなワークフローに沿って実行されます。
- メタデータの読み込み -
skill-knowledge-map.jsonからスキル情報を読み込みます - ドキュメントファイルの検出 -
CLAUDE.md、AGENTS.md、または Cursor のルールファイルを探します - 許可の確認 - 追加する内容と場所を表示します
- 参照の追加 - 「Resources & References」セクションに URL を挿入します
- 完了の報告 - インストールが成功したことを確認します
詳しいワークフローの手順については、install-knowledge.md を参照してください。
パラメーター
SKILL_NAME パラメーター
省略可能です。インストールするスキルのドキュメントを指定します(例:"neon-drizzle")。指定しない場合は、skill-knowledge-map.json で定義されている利用可能なスキルから選択するよう求められます。
使用例
別のスキルから呼び出す場合:
Execute the add-neon-docs skill with SKILL_NAME="neon-drizzle"
ユーザーが直接呼び出す場合:
- 「プロジェクトに neon drizzle のナレッジを追加して」
- 「neon serverless のドキュメントをインストールして」
- 「AI アシスタント用に Neon のベストプラクティスを設定して」
追加される内容
参照は、AI ドキュメントファイルの「Resources & References」セクションに追加されます。
## 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- Claude Code プロジェクトで最も一般的ですAGENTS.md- カスタム AI ドキュメントファイル.cursor/README.mdまたは.cursor/rules.md- Cursor IDE プロジェクト- 該当するファイルがない場合は
CLAUDE.mdを作成します
動作:
- 「Resources & References」セクションが既にある場合:新しいリンクを末尾に追加します
- セクションがない場合:ファイルの末尾にセクションを作成します
- ドキュメントファイルがない場合:参照を含む
CLAUDE.mdを作成します
関連スキル
- neon-drizzle - Drizzle ORM をセットアップし、このスキルを提案します
- neon-serverless - 接続をセットアップし、このスキルを提案します
- neon-toolkit - 一時的なデータベースをセットアップし、このスキルを提案します
ワークフローの参照
実装の詳細については、以下を参照してください。
- ワークフロー:
install-knowledge.md- エラー処理を含む、エージェントの手順を段階的に説明します - メタデータ:
skill-knowledge-map.json- スキル定義と参照 URL
ワークフローの実行
これから、インストールのワークフローを実行します。
受け取ったパラメーター:SKILL_NAME = ${SKILL_NAME || "not provided - will ask user"}
指定された SKILL_NAME を使って install-knowledge.md を実行します。