feat: add LanceDB integration example

[UmeshpJadhav]

PR Checklist

• The commit message follows our guidelines
• Related issue(s) linked
• Tests for the changes have been added
• Docs have been added / updated
• Changesets have been added (Skipped: Example is private)

Bugs / Features

fixes #871

What is the new behavior?

This PR introduces a new example examples/with-lancedb that demonstrates how to integrate LanceDB with VoltAgent.

Key Features:

• Embeddable / Serverless: Uses LanceDB's local mode by default (zero-setup).
• Configurable: Supports LANCEDB_URI environment variable for connecting to LanceDB Cloud.
• Persistent Storage: Automatically creates and persists the vector database in .voltagent/lancedb.
• Dual Agent Demo: Includes both an "Assistant with Retriever" (automatic context injection) and "Assistant with Tools" (agent-decided retrieval) pattern.
• Robust Setup: Includes full TypeScript setup, README.md, and environment configuration.

Notes for reviewer

This example is consistent with with-pinecone and with-chroma. It uses @lancedb/lancedb for vector storage. The implementation includes logic to seed sample documents if the table does not exist.

---

Summary by cubic

Adds the with-lancedb example to integrate LanceDB with VoltAgent for local or cloud vector storage. Demonstrates retrieval with OpenAI embeddings and two agent patterns; fixes #871.

• New Features
  • Embedded LanceDB by default; switch to cloud via LANCEDB_URI.
  • Persistent storage: .voltagent/lancedb (vectors) and .voltagent/memory.db (memory).
  • Retriever with OpenAI text-embedding-3-small and vector search; adds references to context.
  • Two agents: automatic retriever and tool-based retrieval.
  • Auto-seeds sample docs if the table is missing.
  • Includes README, website guide, .env.example, TypeScript setup, and Hono server (port 3000).

^{Written for commit 775cb76. Summary will update on new commits.}

[changeset-bot]

⚠️ No Changeset found

Latest commit: 775cb76

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[cubic-dev-ai]

4 issues found across 7 files

Prompt for AI agents (all issues)

Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="examples/with-lancedb/.env.example">

<violation number="1" location="examples/with-lancedb/.env.example:1">
P2: The default `LANCEDB_URI=./data/lancedb` contradicts the README which states the database is stored in `.voltagent/lancedb`. Consider updating to `.voltagent/lancedb` for consistency with documentation.</violation>
</file>

<file name="examples/with-lancedb/README.md">

<violation number="1" location="examples/with-lancedb/README.md:17">
P2: Node.js version requirement is inconsistent with the project. The root `package.json` requires `node &gt;= 20`, but this README says `Node.js 18+`. Update to `Node.js 20+` for consistency.</violation>
</file>

<file name="examples/with-lancedb/src/retriever/index.ts">

<violation number="1" location="examples/with-lancedb/src/retriever/index.ts:92">
P2: Silent failure when all embeddings fail. If `recordsWithEmbeddings.length` is 0 (all embedding generations failed), the table is never created but no warning is logged. Consider adding an `else` branch to log a warning message so developers understand why the knowledge base isn&#39;t initialized.</violation>
</file>

<file name="examples/with-lancedb/package.json">

<violation number="1" location="examples/with-lancedb/package.json:30">
P1: Zod version ^4.3.5 is inconsistent with the rest of the project which uses ^3.25.76. Zod v4 has breaking API changes that may cause compatibility issues with VoltAgent packages.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

[omeraplak]

Hey @UmeshpJadhav , thanks a lot for the PR, really appreciate it.

Would you also have a chance to add this to the docs as well?
Here are the relevant links:

• https://voltagent.dev/docs/rag/overview/
• https://github.com/VoltAgent/voltagent/tree/main/website/docs/rag

That would be amazing. Thanks again!

[cubic-dev-ai]

2 issues found across 102 files (changes from recent commits).

Note: This PR contains a large number of files. cubic only reviews up to 75 files per PR, so some files may not have been reviewed.

Prompt for AI agents (all issues)

Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name=".changeset/chilly-windows-wink.md">

<violation number="1">
P2: Changeset content doesn&#39;t match PR description. The PR is for adding a LanceDB integration example, but the changeset describes &#39;fix: OutputSpec export&#39; for `@voltagent/core`. This will result in misleading release notes. Either update the changeset to reflect the actual changes, remove it if the example doesn&#39;t require one, or update the PR description to document the OutputSpec fix.</violation>
</file>

<file name="examples/with-cloudflare-workers/wrangler.toml">

<violation number="1">
P2: Hardcoded database ID should be a placeholder. Users need to create their own D1 database and provide their own ID. Consider using an empty string or placeholder like the `account_id` field above.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

[UmeshpJadhav]

@omeraplak thanks for the review.
I have added the LanceDB documentation and updated the overview page as requested

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}