playbooks

home / skills / ofx-labs / seekdb-docs / seekdb-docs

seekdb-docs skill

/SKILL.md

This skill helps you quickly access SeekDB developer and Python SDK documentation to answer questions, implement features, and troubleshoot.

npx playbooks add skill ofx-labs/seekdb-docs --skill seekdb-docs

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
1.8 KB
---
name: seekdb-docs
description: Comprehensive SeekDB vector database documentation access. Use when answering questions about SeekDB development, Python SDK API usage, environment setup, coding standards, testing, debugging, or any SeekDB-related queries. Covers both developer guide (C++ core development) and user guide (Python SDK).
---

# SeekDB Documentation

Access comprehensive documentation for SeekDB vector database, including developer guides and Python SDK reference.

## Documentation Structure

### Developer Guide
Location: `seekdb-docs/developer-guide/{zh,en}/`

- **Environment Setup**: toolchain.md, build-and-run.md, ide-settings.md
- **Coding Standards**: coding-convention.md, coding-standard.md
- **Testing & Debugging**: unittest.md, mysqltest.md, debug.md
- **Core Systems**: memory.md, logging.md, container.md
- **Contributing**: contributing.md

### User Guide - Python SDK
Location: `seekdb-docs/user-guide/{zh,en}/pyseekdb-sdk.md`

Complete Python SDK API reference covering:
- Client objects (embedded/server/OceanBase modes)
- Collection management (create, get, delete)
- Data operations (add, update, upsert, delete)
- Query operations (query, get, hybrid_search)
- Filter conditions (where, where_document)
- Database management (AdminClient)
- Embedding functions

## Workflow

1. **Identify query type**:
   - Developer questions → Developer Guide
   - API/SDK questions → User Guide
   - Specific topics → Use doc index

2. **Locate documentation**:
   - Read `references/doc-index.md` for complete document index
   - All docs available in Chinese (zh/) and English (en/)

3. **Access relevant files**:
   - Read specific markdown files from seekdb-docs/ directory
   - Use grep to search across documentation if needed

## Quick Reference

For detailed document index with full content structure, see `references/doc-index.md`.

Overview

This skill provides fast, comprehensive access to SeekDB vector database documentation covering both core developer topics and the Python SDK user guide. It helps developers and users find environment setup instructions, coding standards, testing/debugging guides, and full Python API references. Use it to locate specific docs, examples, and API details in English or Chinese sources.

How this skill works

The skill inspects the organized documentation tree and directs queries to the appropriate section: developer guide for C++ core work and user guide for Python SDK usage. It locates files such as environment setup, coding conventions, testing guides, and the complete Python SDK API reference including client modes, collection and data operations, queries, filters, and embedding functions. For targeted searches it uses the document index to jump to exact markdown files and supports searching across files when needed.

When to use it

  • Setting up the SeekDB development toolchain, build, or IDE settings
  • Following coding standards or contributing to the SeekDB core
  • Writing, testing, or debugging SeekDB core components in C++
  • Using the Python SDK: clients, collections, data operations, or queries
  • Implementing embeddings, AdminClient workflows, or hybrid search
  • Quickly locating a specific doc page or API reference in English or Chinese

Best practices

  • Start by identifying whether your question is developer-focused or SDK/API-focused to pick the correct guide
  • Reference the doc-index first to find exact filenames and paths (developer-guide/ or user-guide/)
  • Use the Python SDK reference for concrete method signatures and examples before writing client code
  • Follow coding-convention and coding-standard docs when contributing changes to core code
  • Run unit and mysqltest guides for reproducible testing; consult debug.md for troubleshooting steps

Example use cases

  • A new contributor needs a step-by-step environment setup and build instructions for core development
  • An engineer wants method names and arguments for Python SDK collection.create, upsert, or hybrid_search
  • A QA engineer follows unittest.md and mysqltest.md to reproduce and log a failing test
  • A maintainer verifies logging, memory, or container guidelines when diagnosing production issues
  • A developer looks up coding standards before submitting a pull request

FAQ

Are docs available in English and Chinese?

Yes, all documentation is available in both English (en/) and Chinese (zh/).

Where is the complete listing of all documentation files?

Consult the document index (references/doc-index.md) to see the full file list and paths.