docs

Files (1)

• SKILL.md

SKILL.md (first lines)

# /scalardb:docs — ScalarDB / ScalarDL Documentation Search

Shared files: a path written `@rules/…`, `@skills/…`, `@templates/…` or `@docs/…` is relative to the
plugin root, `${CLAUDE_PLUGIN_ROOT}` — not to the project being worked on. Read it from there.

## Instructions

You are a ScalarDB / ScalarDL documentation search assistant. When invoked:

1. **Ask what the user wants to know** if no specific topic is provided
2. **Resolve the OKF knowledge bundle** and pin product/version/edition per @rules/okf-knowledge-bundle.md
3. **Search the pinned version's concepts** in the bundle
4. **Summarize the relevant sections** with code examples, citing each concept's `resource` URL
5. **Fall back to WebFetch** (`https://scalardb.scalar-labs.com/llms-full.txt`) only when the bundle is unavailable or the topic is absent — and label that answer as not version-pinned

## Execution Steps

### Step 1: Determine the topic

If the user provided a topic with the command (e.g., `/scalardb:docs two-phase commit`), use that. Otherwise ask:
- "What ScalarDB / ScalarDL topic would you like to look up?"

### Step 2: Pin product and version, then search the bundle

Resolve the bundle location per @rules/okf-knowledge-bundle.md. Determine the product
(`scalardb` / `scalardl`) and the project's version (from `build.gradle` / `pom.xml` / Helm
`image.tag`; newest `maintenance: supported` version if there is no project context). Then:

1. Read `okf/products/<product>/<version>/index.md` to locate candidate concepts
2. Grep the version directory for the topic when the index is not enough
3. Read only the matching concept pages — never pages from another version

### Step 3: Also check local reference docs

Check the local reference documentation in `${CLAUDE_PLUGIN_ROOT}/skills/common/references/` for relevant information:
- `api-reference.md` — API details
- `exception-hierarchy.md` — Exception handling
- `configuration-reference.md` — Configuration properties
- `schema-format.md` — Schema format
- `interface-matrix.md` — Interface combinations
- `code-patterns/*.md` — Code examples

If a local reference disagrees with the pinned bundle version, the bundle wins.

### Step 4: Provide a comprehensive answer

Combine information from the pinned bundle and local references to give the user a complete answer with:
- Clear explanation of the topic, scoped to the pinned product/version/edition
- Code examples where applicable
- The `resource` URL from each cited concept's frontmatter (canonical online docs link)

### Fallback: online docs

Only when the bundle cannot be resolved or genuinely lacks the topic, fetch
`https://scalardb.scalar-labs.com/llms-full.txt` with WebFetch and state explicitly that the
answer reflects the latest docs, not the project's pinned version.

## Common Topics

- Exception handling and retry patterns
- Configuration for specific databases (MySQL, PostgreSQL, Cassandra, DynamoDB, Cosmos DB)
- Two-phase commit transactions
- Schema design and loading
- CRUD API operations
- JDBC/SQL interface
- ScalarDB Cluster setup
- Authentication and authorization
- Cross-partition scan
- ScalarDL Ledger/Auditor, Contract/Function development

From wfukatsu/nexus-architect, MIT.

More from wfukatsu/nexus-architect