Skip to content

Conversation

@davidzhangbj
Copy link
Contributor

Summary

This PR adds a new Seekdb Claude Code Plugin to the OceanBase ecology-plugins collection. The plugin provides comprehensive seekdb database documentation support for Claude Code through Agent Skills, enabling AI assistants to access seekdb best practices, SQL syntax, Python SDK patterns, vector search, and hybrid search guidelines.

This plugin enhances the developer experience when working with seekdb in Claude Code by providing instant access to technical documentation and best practices without cluttering the project with large documentation files.

Solution Description

The plugin implements a Claude Code Agent Skill called seekdb-docs that provides a complete seekdb documentation knowledge base. The implementation includes:

Core Components

  1. Plugin Configuration (plugin.json):

    • Defines the plugin metadata, version (0.1.0), and description
    • Configures the plugin for Claude Code marketplace integration
  2. Documentation Skill (skills/seekdb-docs/):

    • Implements the seekdb-docs Agent Skill with semantic search capabilities
    • Organizes documentation into structured categories:
      • Quick Start Guide: Getting started with seekdb, deployment, basic operations
      • Development Guide: Vector search, hybrid search, AI functions, Python SDK, multi-model data support (JSON, spatial, text)
      • Integration Guide: Model integrations (Jina, OpenAI, Qwen), framework integrations (LangChain, LlamaIndex, SpringAI, Dify, n8n), MCP client integrations
      • Operations Guide: Deployment, monitoring, configuration, reference documentation
      • Practice Tutorials: Real-world application examples and demos
  3. Documentation Structure:

    • Comprehensive official documentation library organized in official-docs/ directory
    • Index files (get-started.md, develop.md, integrations.md, guides.md, tutorials.md) for easy navigation
    • Documentation files follow a clear naming convention for easy discovery
  4. Documentation:

    • Complete README files in both English and Chinese
    • Installation and usage instructions
    • Examples demonstrating how to use the plugin with Claude Code

Key Features

  • Automatic Invocation: The skill is automatically invoked by Claude based on context when users ask seekdb-related questions
  • Semantic Search: Supports content-based semantic search across all documentation
  • Comprehensive Coverage: Includes all major seekdb features including vector search, hybrid search, AI functions, and multi-model data support
  • Easy Integration: Simple installation via Claude Code marketplace
  • No Project Clutter: Documentation is accessed on-demand without adding large files to user projects

Usage

Users can install the plugin via:
/plugin marketplace add oceanbase/ecology-plugins
/plugin install seekdb-plugin@seekdbOnce installed, Claude Code will automatically access seekdb documentation when users ask questions like:

  • "How to deploy a seekdb test environment?"
  • "How to use seekdb's vector search functionality?"
  • "How to implement hybrid search in seekdb?"
  • "Which AI framework integrations does seekdb support?"

This plugin follows the same pattern as other plugins in the ecology-plugins collection and integrates seamlessly with the existing ecosystem.

@davidzhangbj davidzhangbj changed the title feat : Add seek db plugin feat : Add seekdb claude code plugin Nov 26, 2025
@xxsc0529 xxsc0529 merged commit 8ec119b into oceanbase:main Nov 26, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants