mcpField
S
seekdb-docs

seekdb-docs

github.com/oceanbase数据与数据库9325 次安装31 周前更新
代码仓库

关于 seekdb-docs

seekdb-docs 是面向 seekdb 使用者与开发者的文档检索技能，通过目录搜索并读取相关文档，覆盖入门、开发、集成和参考内容。

主要功能

  1. 01目录搜索约 1,000 篇文档
  2. 02按描述匹配相关文档
  3. 03本地优先读取并支持远程回退
  4. 04覆盖多个文档版本
  5. 05本地文档可离线使用

适用场景

  1. 01查找 seekdb 功能与 SQL 参考
  2. 02了解开发及集成步骤
  3. 03查询部署、安全或性能指南

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/oceanbase/seekdb-ecology-plugins --skill seekdb-docs

安装后在 Claude Code 中输入/seekdb-docs确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
_catalog_hash_cache.json
examples.md
seekdb-docs-catalog.jsonl
scripts/
generate_catalog.py
update_docs.sh
seekdb-docs/
10.doc-overview.md
seekdb-docs/100.get-started/10.overview/
10.seekdb-overview.md
seekdb-docs/100.get-started/10.seekdb-overview/
10.seekdb-overview.md
seekdb-docs/100.get-started/100.use-seekdb-with-sql/
10.deploy-seekdb-testing-environment.md
5.experience-vector-search-with-sql.md
seekdb-docs/100.get-started/110.use-seekdb-with-skill/
100.agent-skills.md
seekdb-docs/100.get-started/200.ai-coding/
100.building-personal-knowledge-base-through-ai-dialogue-using-seekdb-mcp-server.md
200.building-an-ai-programming-assistant-that-understands-vector-databases-with-seekdb-claude-code.md
300.making-cursor-ai-instantly-understand-seekdb-a-guide-to-using-the-seekdb-cursor-extension.md
seekdb-docs/100.get-started/5.changelog/
10.changelog.md
seekdb-docs/100.get-started/50.use-seekdb-with-sdk/
10.experience-vector-search-with-sdk.md
25.using-seekdb-in-python-sdk.md
seekdb-docs/200.develop/10.develop-overview/
10.develop-overview.md
seekdb-docs/200.develop/10.overview/
10.develop-overview.md
seekdb-docs/200.develop/100.connect-to-seekdb/
100.connection-methods-overview.md
seekdb-docs/200.develop/100.connect-to-seekdb/200.use-client-connect-seekdb/
100.connect-to-seekdb-by-using-a-mysql-client.md
seekdb-docs/200.develop/100.connect-to-seekdb/300.sample-program/100.java/
100.connect-to-seekdb-through-spring-boot.md
200.connect-to-seekdb-through-spring-batch.md
300.connect-to-seekdb-through-spring-jdbc.md
400.connect-to-seekdb-through-springjpa.md
500.connect-to-seekdb-through-hibernate.md
600.connect-to-seekdb-through-mybatis.md
700.connect-to-seekdb-through-mysql-connectorJ.md
seekdb-docs/200.develop/100.connect-to-seekdb/300.sample-program/200.python/
100.mysqlclient-connection-to-seekdb-sample-program.md
200.pymysql-connection-to-seekdb-sample-program.md

详细介绍

seekdb 文档

通过基于目录的搜索系统访问约 1,000 条 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——每行一个 {"path": "...", "description": "...", "branch": "..."}（约 1,000 条）
步骤 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
  • 教程：分步场景

评论

支持 Markdown