seekdb-docs

seekdb ドキュメント

カタログベースの検索システムを通じて、約 1000 件の seekdb ドキュメントにアクセスできます。

バージョン情報

• 対象となるドキュメントのバージョン：V1.0.0、V1.1.0（統合済み。新しいバージョンが優先されます）

• 最新バージョン：V1.1.0

• カタログエントリーの branch フィールドは、ファイルが存在する Git ブランチ（リモートのフォールバック URL にのみ使用）を示します。seekdb のどのバージョンに内容が適用されるかを示すものではありません。多くのドキュメントはすべてのバージョンに適用されます。

• ユーザーが特定の seekdb バージョンについて質問した場合は、このドキュメントセットには最新の利用可能な内容が反映されており、バージョン固有の違いが区別されていない場合があることを伝えてください。

パスの解決（最初に実行）

すべてのリソースパスは、この SKILL.md の場所を基準とした相対パスです。まずスキルディレクトリを解決してください。

1. この SKILL.md を読み、絶対パスを取得します
2. 親ディレクトリを <skill_dir> として取り出します
3. カタログ：<skill_dir>references/seekdb-docs-catalog.jsonl
4. ドキュメントのベースディレクトリ：<skill_dir>seekdb-docs/

ワークフロー

ステップ 1：カタログを検索する

Grep 検索（クエリの約 90% で推奨）：

grep -i "keyword" <skill_dir>references/seekdb-docs-catalog.jsonl

カタログ全体の読み込み（grep で結果が見つからない場合、または意味によるマッチングが必要な場合のみ）：

• ローカル：<skill_dir>references/seekdb-docs-catalog.jsonl
• リモートのフォールバック：https://raw.githubusercontent.com/oceanbase/seekdb-ecology-plugins/main/agent-skills/skills/seekdb/references/seekdb-docs-catalog.jsonl
• 形式：JSONL — 1 行につき {"path": "...", "description": "...", "branch": "..."}（約 1000 件）

ステップ 2：クエリに一致させる

• 検索結果から path、description、branch を取り出します
• 説明がクエリの意味に最もよく合うエントリーを選択します（キーワードだけでなく、意味で一致させます）
• 網羅的な回答にするため、複数の候補を検討します

ステップ 3：ドキュメントを読む

ローカルを優先し、見つからない場合はリモートにフォールバックします。

1. ローカルを試します：<skill_dir>seekdb-docs/[path]
2. フォールバック：https://raw.githubusercontent.com/oceanbase/seekdb-doc/[branch]/en-US/[path]
   • [branch] はカタログエントリーの branch フィールドから取得します（例：V1.0.0、V1.1.0）
   • ドキュメントは複数のバージョンブランチにまたがっており、特定のブランチにしか存在しないファイルもあります

例

Query: "How to integrate with Claude Code?"

1. grep -i "claude code" <skill_dir>references/seekdb-docs-catalog.jsonl
2. Match: {"path": "300.integrations/300.developer-tools/700.claude-code.md",
           "description": "This guide explains how to use the seekdb plugin with Claude Code...",
           "branch": "V1.0.0"}
3. Read: <skill_dir>seekdb-docs/300.integrations/300.developer-tools/700.claude-code.md
   Fallback: https://raw.githubusercontent.com/oceanbase/seekdb-doc/V1.0.0/en-US/300.integrations/300.developer-tools/700.claude-code.md

ワークフローの詳しい例については、examples.md を参照してください。

注意事項

• ローカルドキュメント（任意）：scripts/update_docs.sh を実行すると、すべてのバージョンブランチからドキュメントをダウンロードして統合できます
• 複数バージョン：ドキュメントは複数のブランチにまたがっています。更新スクリプトはドキュメントを統合し、各ファイルの取得元ブランチをカタログに記録します
• オフラインで利用可能：ローカルドキュメントとカタログがあれば、完全にオフラインで動作します

カテゴリの概要

• はじめに：クイックスタート、基本操作、概要
• 開発：ベクトル検索、ハイブリッド検索、AI 関数、MCP、マルチモデル
• 連携：フレームワーク、モデルプラットフォーム、開発者ツール、ワークフロー
• ガイド：デプロイ、管理、セキュリティ、OBShell、パフォーマンス
• リファレンス：SQL 構文、PL、エラーコード、SDK API
• チュートリアル：手順ごとのシナリオ