Skip to main content

GPU-accelerated RAG module for vaultspec vault search

Project description

vaultspec-rag

Python CI MCP uv License: MIT


Semantic search for your vaultspec vault and project codebase

vaultspec-rag adds GPU-accelerated search to projects managed by vaultspec-core. It indexes your .vault/ documents -- research notes, architecture decisions, plans, execution logs -- alongside your source code. Query both with natural language so your AI tools find relevant context on their own.


Getting started

Prerequisites

  • Python 3.13 or later
  • uv
  • A CUDA GPU with at least 3 GB VRAM (mandatory -- no CPU fallback)
  • vaultspec-core

Install

uv add vaultspec-rag

This pulls in vaultspec-core and all GPU dependencies.

Verify

vaultspec-rag --version

Index and search

vaultspec-rag indexes two sources: vault (.vault/ documents) and code (project source files).

vaultspec-rag index                          # both
vaultspec-rag index --type vault             # vault only
vaultspec-rag index --type code              # code only

vaultspec-rag search "architecture decision"
vaultspec-rag search --type code "error handling"

Using the MCP server

The Model Context Protocol (MCP) server gives AI assistants direct access to vault and codebase search. It runs in two transport modes with different project-resolution rules.

stdio mode -- one process per project. The MCP client launches vaultspec-search-mcp as a subprocess, scoped to a single workspace via VAULTSPEC_RAG_ROOT. Use this for Claude Desktop, Claude Code, and similar single-project AI tools.

{
  "mcpServers": {
    "vaultspec-rag": {
      "command": "vaultspec-search-mcp",
      "env": {
        "VAULTSPEC_RAG_ROOT": "/path/to/your/project"
      }
    }
  }
}

HTTP mode -- one daemon, many projects. Start vaultspec-rag server service start as a background daemon, then connect any MCP client to http://127.0.0.1:8766/mcp. The daemon has no default project; every tool call must include project_root. Use this to share one GPU-loaded service across workspaces.

See the MCP integration reference for the full tool list, both modes' contracts, and choosing between them.


Further reading

Guide What it covers
Usage modes Ad-hoc vs. service operation
CLI commands Command tree, flags, --port fast path
Configuration Precedence, environment variables, .vaultragignore
Service management Background daemon, health endpoint, model warmup
Python API Facade functions for programmatic use
Architecture overview Access layers, GPU lifecycle, multi-project support
Models Embedding stack and model cards

Getting help

Open an issue on GitHub.


Contributing and license

Contributions welcome -- bug reports, feature ideas, or pull requests. vaultspec-rag uses the MIT License.

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

vaultspec_rag-0.2.0a0.tar.gz (702.2 kB view details)

Uploaded Source

Built Distribution

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

vaultspec_rag-0.2.0a0-py3-none-any.whl (175.4 kB view details)

Uploaded Python 3

File details

Details for the file vaultspec_rag-0.2.0a0.tar.gz.

File metadata

  • Download URL: vaultspec_rag-0.2.0a0.tar.gz
  • Upload date:
  • Size: 702.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for vaultspec_rag-0.2.0a0.tar.gz
Algorithm Hash digest
SHA256 59b7252ce8c6df12ac82774e591a9ab6f6b3cf7847153195bf86766c83a09b5b
MD5 0a6048869b1bd0b195479f8a1eb981be
BLAKE2b-256 fa54665704163df0ce7b08ed1a686f68183445dea93eda59e8dae2425ecf5a90

See more details on using hashes here.

File details

Details for the file vaultspec_rag-0.2.0a0-py3-none-any.whl.

File metadata

  • Download URL: vaultspec_rag-0.2.0a0-py3-none-any.whl
  • Upload date:
  • Size: 175.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for vaultspec_rag-0.2.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 5cb08cfa39c893bab4b4fc019374dc354a600b66e014b4626899f008b40e825f
MD5 204a982ed4dc34aca6c4517cbf198dd0
BLAKE2b-256 446f3e4b5de6c98915f17f78f18cf0c5e23c745fc78a5bbbe3b32d99d38f531d

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