OA0 = Omni AI 0
OA0 是一个探索 AI 的论坛
现在注册
已注册用户请  登录
OA0  ›  技能包  ›  seekdb-docs:提供 seekdb 数据库的文档和知识库

seekdb-docs:提供 seekdb 数据库的文档和知识库

 
  oa0 ·  2026-02-14 10:27:09 · 3 次点击  · 0 条评论  

名称: seekdb-docs
描述: seekdb 数据库文档查询工具。当用户询问 seekdb 功能、SQL 语法、向量搜索、混合搜索、集成、部署或任何与 seekdb 相关的话题时使用。通过基于目录的语义搜索自动定位相关文档。
版本: "V1.1.0"


seekdb 文档查询

通过集中式目录系统提供对 seekdb 数据库文档的全面访问。

快速开始

  1. 定位技能目录(参见下文“路径解析”)
  2. 加载完整目录(1015 个文档条目)
  3. 语义匹配查询与目录条目
  4. 读取匹配条目对应的文档

路径解析(关键第一步)

问题:像 ./seekdb-docs/ 这样的相对路径是相对于当前工作目录解析的,而不是相对于 SKILL.md 文件的位置。当代理的工作目录与技能目录不同时,这会导致路径错误。

解决方案:在访问文档之前,动态定位技能目录。

分步解析

  1. 读取 SKILL.md 文件本身以获取其绝对路径:
    read(SKILL.md) // 或此技能目录中的任何已知文件

  2. 从返回的路径中提取目录
    如果 read 返回:/root/test-claudecode-url/.cursor/skills/seekdb/SKILL.md 技能目录则为:/root/test-claudecode-url/.cursor/skills/seekdb/

  3. 使用此目录构建路径
    目录路径:<技能目录>references/seekdb-docs-catalog.jsonl 文档基础路径:<技能目录>seekdb-docs/

文档来源

完整目录

  • 本地<技能目录>references/seekdb-docs-catalog.jsonl(1015 个条目,JSONL 格式)
  • 远程https://raw.githubusercontent.com/oceanbase/seekdb-ecology-plugins/main/agent-skills/skills/seekdb/references/seekdb-docs-catalog.jsonl(备用)
  • 条目数:1015 个文档文件
  • 覆盖范围:完整的 seekdb 文档
  • 格式:JSONL - 每行一个 JSON 对象,包含路径和描述

完整文档(本地优先,远程备用)

本地文档(如果可用):
- 基础路径<技能目录>seekdb-docs/
- 大小:7.4M,952 个 Markdown 文件
- 文档路径:基础路径 + 文件路径

远程文档(备用):
- 基础 URLhttps://raw.githubusercontent.com/oceanbase/seekdb-doc/V1.1.0/en-US/
- 文档 URL:基础 URL + 文件路径

策略
1. 定位:使用上述路径解析方法确定 <技能目录>
2. 加载:加载完整目录(1015 个条目)- 优先尝试本地,失败则回退到远程
3. 搜索:在所有目录条目中进行语义搜索
4. 读取:优先尝试读取本地文档,若缺失则回退到远程 URL

工作流程

步骤 0:解析路径(首先执行此步骤!)

# 读取此文件以发现其绝对路径
read("SKILL.md")

# 从路径中提取目录
# 示例:/root/.claude/skills/seekdb/SKILL.md → /root/.claude/skills/seekdb/

步骤 1:搜索目录

首先使用 grep 进行关键词搜索。仅在必要时加载完整目录。

方法 1:Grep 搜索(适用于 90% 的查询)

使用 grep 在目录中搜索关键词:

grep -i "关键词" <技能目录>references/seekdb-docs-catalog.jsonl

示例

# 查找 macOS 部署文档
grep -i "mac" references/seekdb-docs-catalog.jsonl

# 查找 Docker 部署文档
grep -i "docker\|container" references/seekdb-docs-catalog.jsonl

# 查找向量搜索文档
grep -i "vector" references/seekdb-docs-catalog.jsonl

方法 2:加载完整目录(仅在必要时)

仅在以下情况下加载完整目录:
- Grep 未返回结果
- 需要进行复杂的语义匹配
- 没有特定的关键词可搜索

本地:<技能目录>references/seekdb-docs-catalog.jsonl
远程:https://raw.githubusercontent.com/oceanbase/seekdb-ecology-plugins/main/agent-skills/skills/seekdb/references/seekdb-docs-catalog.jsonl(备用)
格式:JSONL(每行一个 JSON 对象)
条目数:1015 个文档文件

策略
1. 优先尝试本地目录:<技能目录>references/seekdb-docs-catalog.jsonl
2. 如果本地缺失,则从上述远程 URL 获取

目录内容
- 每行:{"path": "...", "description": "..."}
- 所有 seekdb 文档均已索引
- 针对语义搜索和 grep 查询进行了优化

步骤 2:匹配查询

分析搜索结果以识别最相关的文档:

对于 grep 结果
- 查看 grep 输出的匹配行
- 从每个匹配项中提取 pathdescription
- 选择描述与查询最匹配的文档
- 考虑多个匹配项以提供全面的答案

对于完整目录
- 将每行解析为 JSON 以提取路径和描述
- 对描述文本执行语义匹配
- 根据含义匹配,而不仅仅是关键词
- 返回所有相关条目以提供全面的答案

注意:目录包含 pathdescription 字段。description 字段包含主题和功能关键词,使其适用于关键词和语义匹配。

步骤 3:读取文档

本地优先策略

  1. 优先尝试本地<技能目录>seekdb-docs/[文件路径]

    • 如果文件存在 → 本地读取(快速)
    • 如果文件缺失 → 进行步骤 2
  2. 回退到远程https://raw.githubusercontent.com/oceanbase/seekdb-doc/V1.1.0/en-US/[文件路径]

    • 从 GitHub 下载

示例

查询:"如何与 Claude Code 集成?"

1. 解析路径:read(SKILL.md) → /root/.claude/skills/seekdb/SKILL.md
   技能目录:/root/.claude/skills/seekdb/

2. 使用 grep 搜索目录:
   grep -i "claude code" /root/.claude/skills/seekdb/references/seekdb-docs-catalog.jsonl

3. 从 grep 结果中匹配查询:
   → 找到:{"path": "300.integrations/300.developer-tools/700.claude-code.md",
            "description": "本指南解释了如何在 Claude Code 中使用 seekdb 插件..."}
   → 这与查询匹配,选择此文档

4. 读取文档:
   尝试:/root/.claude/skills/seekdb/seekdb-docs/300.integrations/300.developer-tools/700.claude-code.md
   如果缺失:https://raw.githubusercontent.com/oceanbase/seekdb-doc/V1.1.0/en-US/300.integrations/300.developer-tools/700.claude-code.md

指导原则

  • 始终首先解析路径:使用“读取自身 SKILL.md”的技巧获取绝对路径
  • 关键词查询优先使用 grep:仅在 grep 无结果或需要语义匹配时加载完整目录
  • 语义匹配:根据含义匹配,而不仅仅是关键词
  • 多个匹配项:读取所有相关条目以提供全面的答案
  • 本地优先,远程备用:优先尝试本地文档,缺失则使用远程 URL
  • 可选本地文档:运行 scripts/update_docs.sh 将完整文档下载到本地(更快)
  • 支持离线:如果存在本地文档,则完全离线工作

目录搜索格式

目录文件采用 JSONL 格式(每行一个 JSON 对象):

{"path": "path/to/document.md", "description": "文档描述文本"}

搜索目录

  • 关键词搜索:使用 grep(参见步骤 1 示例)。每个匹配行都包含路径和描述。
  • 当 grep 不足时:读取完整目录,将每行解析为 JSON,然后对描述进行语义匹配。

常见安装路径

此技能可能安装在:
- Cursor.cursor/skills/seekdb/
- Claude Code.claude/skills/seekdb/
- 自定义:任何目录(路径解析会自动处理)

请勿硬编码这些路径。请使用动态解析方法。

详细示例

请参阅 examples.md 以获取完整的工作流程示例,包括:
- 完整目录搜索场景
- 本地优先查找场景
- 远程备用场景
- 集成查询
- 多轮对话

类别概览

  • 入门指南:快速开始、基本操作、概述
  • 开发:向量搜索、混合搜索、AI 函数、MCP、多模型
  • 集成:框架、模型平台、开发者工具、工作流
  • 指南:部署、管理、安全、OBShell、性能
  • 参考:SQL 语法、PL、错误代码、SDK API
  • 教程:分步场景
3 次点击  ∙  0 人收藏  
登录后收藏  
目前尚无回复
0 条回复
About   ·   Help   ·    
OA0 - Omni AI 0 一个探索 AI 的社区
沪ICP备2024103595号-2
Developed with Cursor