Skip to main content

mcp-lance-db

Project description

mcp-lance-db: A LanceDB MCP server

The Model Context Protocol (MCP) is an open protocol that enables seamless integration between LLM applications and external data sources and tools. Whether you're building an AI-powered IDE, enhancing a chat interface, or creating custom AI workflows, MCP provides a standardized way to connect LLMs with the context they need.

This repository is an example of how to create a MCP server for LanceDB, an embedded vector database.

Overview

A basic Model Context Protocol server for storing and retrieving memories in the LanceDB vector database. It acts as a semantic memory layer that allows storing text with vector embeddings for later retrieval.

Components

Tools

The server implements two tools:

  • add-memory: Adds a new memory to the vector database

    • Takes "content" as a required string argument
    • Stores the text with vector embeddings for later retrieval
  • search-memories: Retrieves semantically similar memories

    • Takes "query" as a required string argument
    • Optional "limit" parameter to control number of results (default: 5)
    • Returns memories ranked by semantic similarity to the query
    • Updates server state and notifies clients of resource changes

Configuration

The server uses the following configuration:

  • Database path: "./lancedb"
  • Collection name: "memories"
  • Embedding provider: "sentence-transformers"
  • Model: "BAAI/bge-small-en-v1.5"
  • Device: "cpu"
  • Similarity threshold: 0.7 (upper bound for distance range)

Quickstart

Claude Desktop

On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "lancedb": {
    "command": "uvx",
    "args": [
      "mcp-lance-db"
    ]
  }
}

Development

Building and Publishing

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package distributions:
uv build

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags:

  • Token: --token or UV_PUBLISH_TOKEN
  • Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

npx @modelcontextprotocol/inspector uv --directory $(PWD) run mcp-lance-db

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_lance_db-0.1.6.tar.gz (56.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_lance_db-0.1.6-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file mcp_lance_db-0.1.6.tar.gz.

File metadata

  • Download URL: mcp_lance_db-0.1.6.tar.gz
  • Upload date:
  • Size: 56.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.3

File hashes

Hashes for mcp_lance_db-0.1.6.tar.gz
Algorithm Hash digest
SHA256 757af1de3e88dd2ebcee301f18d83a0222d8e00977c1a8982390900f063a37dd
MD5 0d52800cebcd7201171592b54e3969ec
BLAKE2b-256 99f507d0c697f71f456fc8881457742607e3ebc2394e78ad05da906595e08d90

See more details on using hashes here.

File details

Details for the file mcp_lance_db-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_lance_db-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 233e271324773213c49107b26712547a4e4ed7740c45b73b1d95a785bdda0dd5
MD5 852dd73789955cafddb77c1bdff15812
BLAKE2b-256 78f789a987472f6987d6dc18c62c027e4a554afe7658320e015599f011b9abb2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page