LanceDB Agent Rules

A database for vector, full-text, and hybrid retrieval with Rust, Python, TypeScript, and Java interfaces.

On this page

Overview

LanceDB follows one table method from the Rust core through remote implementations and language bindings. The guide also warns about stale native extensions, hand-maintained API references, and documentation checks missing from pull-request CI.

Documents

├── 
├──  · symlink → AGENTS.md
├── docs
│   └── src
│       └── python
│           └── 
├── nodejs
│   ├── 
│   └──  · symlink → AGENTS.md
└── python
    ├── 
    └──  · symlink → AGENTS.md

Patterns in this file

01 / Architecture as narrative

Trace a feature across implementation boundaries

The new-method plan walks through the Table trait, native and remote implementations, Python binding layers, and TypeScript wrappers. It names tests and generated definitions at the steps where they become necessary.

Source excerpt starting at line 74.
Adding a new method involves first adding it to the Rust core, then exposing itin the Python and TypeScript bindings. There are both local and remote tables.Remote tables are implemented via a HTTP API and require the `remote` cargofeature flag to be enabled. Python has both sync and async methods.

02 / Behavioral framing

Rebuild stale extensions before giving up

Python validation uses the locked uv environment. Missing or stale Rust/PyO3 bindings have a prescribed rebuild path instead of being treated as final evidence that tests cannot run.

Source excerpt starting at line 32.
final blockers; bootstrap or enter the uv environment instead. If `lancedb._lancedb`is missing or stale, or if Rust/PyO3 binding code changed, rebuild the Pythonextension with the bootstrap command above before running tests.

03 / Pointing at the source of truth

Expose what the documentation build does not discover

The Python API reference is hand-maintained. Some modules derive symbols from __all__, while others need individual directives, so a new public API can be silently absent from the rendered reference.

Source excerpt starting at line 113.
`docs/src/python/python.md` is the entire Python API reference. It is maintained byhand, and anything not listed there is not rendered at all, so new public classes andmodule-level functions have to be added explicitly. How depends on the module:

04 / Verification by change type

Name the documentation check missing from PR CI

The guide supplies a local MkDocs build command after explaining reference-link syntax. It explicitly says the docs site only builds on main, preventing a green PR from being read as evidence that documentation renders.

Source excerpt starting at line 136.
The docs site only builds on pushes to `main`, so this is not covered by PR CI.

Ideas for your repo

  1. Show a representative feature crossing every public binding layer.
  2. Give stale generated extensions a recovery procedure.
  3. Explain which documentation symbols require manual registration.
  4. State the verification gaps in a successful PR check run.
Sponsored byModem

Give your agents the whole story.

These instructions explain how to work in LanceDB. Modem shows your agents what customers said, who is affected, and what changed.

See how Modem works