Skip to main content

Integrate RAG into AI Agents via MCP Server. Supports multiple Vector database technologies.

Project description

Vector Database MCP Server

PyPI - Version PyPI - Downloads GitHub Repo stars GitHub forks GitHub contributors PyPI - License GitHub

GitHub last commit (by committer) GitHub pull requests GitHub closed pull requests GitHub issues

GitHub top language GitHub language count GitHub repo size GitHub repo file count (file type) PyPI - Wheel PyPI - Implementation

Version: 0.1.10

This is an MCP Server implementation which allows for a standardized collection management system across vector database technologies.

This was heavily inspired by the RAG implementation of Microsoft's Autogen V1 framework, however, this was changed to an MCP server model instead.

AI Agents can:

  • Create collections with documents stored on the local filesystem or URLs
  • Add documents to a collection
  • Utilize collection for retrieval augmented generation (RAG)
  • Delete collection

Supports:

  • ChromaDB
  • PGVector - 90% Tested
  • Couchbase - 80% Tested
  • Qdrant - 80% Tested
  • MongoDB - 80% Tested

This repository is actively maintained - Contributions and bug reports are welcome!

Automated tests are planned

Usage:

MCP CLI

Short Flag Long Flag Description
-h --help Display help information
-t --transport Transport method: 'stdio', 'http', or 'sse' [legacy] (default: stdio)
-s --host Host address for HTTP transport (default: 0.0.0.0)
-p --port Port number for HTTP transport (default: 8000)
--auth-type Authentication type: 'none', 'static', 'jwt', 'oauth-proxy', 'oidc-proxy', 'remote-oauth' (default: none)
--token-jwks-uri JWKS URI for JWT verification
--token-issuer Issuer for JWT verification
--token-audience Audience for JWT verification
--oauth-upstream-auth-endpoint Upstream authorization endpoint for OAuth Proxy
--oauth-upstream-token-endpoint Upstream token endpoint for OAuth Proxy
--oauth-upstream-client-id Upstream client ID for OAuth Proxy
--oauth-upstream-client-secret Upstream client secret for OAuth Proxy
--oauth-base-url Base URL for OAuth Proxy
--oidc-config-url OIDC configuration URL
--oidc-client-id OIDC client ID
--oidc-client-secret OIDC client secret
--oidc-base-url Base URL for OIDC Proxy
--remote-auth-servers Comma-separated list of authorization servers for Remote OAuth
--remote-base-url Base URL for Remote OAuth
--allowed-client-redirect-uris Comma-separated list of allowed client redirect URIs
--eunomia-type Eunomia authorization type: 'none', 'embedded', 'remote' (default: none)
--eunomia-policy-file Policy file for embedded Eunomia (default: mcp_policies.json)
--eunomia-remote-url URL for remote Eunomia server

Using as an MCP Server

The MCP Server can be run in two modes: stdio (for local testing) or http (for networked access). To start the server, use the following commands:

Run in stdio mode (default):

vector-mcp --transport "stdio"

Run in HTTP mode:

vector-mcp --transport "http"  --host "0.0.0.0"  --port "8000"

Creating Collection

AI Prompt:

Create a collection called zapdos with the documents in this directory:
/home/user/Documents/Chroma

AI Response:

The collection named "zapdos" has been successfully created or retrieved from the vector database
using the documents in the directory /home/user/Documents/Chroma.
Let me know if you'd like to perform any further actions, such as querying the collection or adding more documents!

Retrieving from Collection

AI Prompt:

Create a collection called zapdos with the documents in this directory:
/home/user/Documents/Chroma

AI Response:

The collection named "zapdos" has been successfully created or retrieved from the vector database
using the documents in the directory /home/user/Documents/Chroma.
Let me know if you'd like to perform any further actions, such as querying the collection or adding more documents!

Deleting Collection

AI Prompt:

Delete the collection called memory

AI Response:

The collection named "memory" has been successfully deleted.
Let me know if you'd like to create a new collection or perform any other actions!

Deploy MCP Server as a Service

The MCP server can be deployed using Docker, with configurable authentication, middleware, and Eunomia authorization.

Using Docker Run

docker pull knucklessg1/vector-mcp:latest

docker run -d \
  --name vector-mcp \
  -p 8004:8004 \
  -e HOST=0.0.0.0 \
  -e PORT=8004 \
  -e TRANSPORT=http \
  -e AUTH_TYPE=none \
  -e EUNOMIA_TYPE=none \
  knucklessg1/vector-mcp:latest

For advanced authentication (e.g., JWT, OAuth Proxy, OIDC Proxy, Remote OAuth) or Eunomia, add the relevant environment variables:

docker run -d \
  --name vector-mcp \
  -p 8004:8004 \
  -e HOST=0.0.0.0 \
  -e PORT=8004 \
  -e TRANSPORT=http \
  -e AUTH_TYPE=oidc-proxy \
  -e OIDC_CONFIG_URL=https://provider.com/.well-known/openid-configuration \
  -e OIDC_CLIENT_ID=your-client-id \
  -e OIDC_CLIENT_SECRET=your-client-secret \
  -e OIDC_BASE_URL=https://your-server.com \
  -e ALLOWED_CLIENT_REDIRECT_URIS=http://localhost:*,https://*.example.com/* \
  -e EUNOMIA_TYPE=embedded \
  -e EUNOMIA_POLICY_FILE=/app/mcp_policies.json \
  knucklessg1/vector-mcp:latest

Using Docker Compose

Create a docker-compose.yml file:

services:
  vector-mcp:
    image: knucklessg1/vector-mcp:latest
    environment:
      - HOST=0.0.0.0
      - PORT=8004
      - TRANSPORT=http
      - AUTH_TYPE=none
      - EUNOMIA_TYPE=none
    ports:
      - 8004:8004

For advanced setups with authentication and Eunomia:

services:
  vector-mcp:
    image: knucklessg1/vector-mcp:latest
    environment:
      - HOST=0.0.0.0
      - PORT=8004
      - TRANSPORT=http
      - AUTH_TYPE=oidc-proxy
      - OIDC_CONFIG_URL=https://provider.com/.well-known/openid-configuration
      - OIDC_CLIENT_ID=your-client-id
      - OIDC_CLIENT_SECRET=your-client-secret
      - OIDC_BASE_URL=https://your-server.com
      - ALLOWED_CLIENT_REDIRECT_URIS=http://localhost:*,https://*.example.com/*
      - EUNOMIA_TYPE=embedded
      - EUNOMIA_POLICY_FILE=/app/mcp_policies.json
    ports:
      - 8004:8004
    volumes:
      - ./mcp_policies.json:/app/mcp_policies.json

Run the service:

docker-compose up -d

Configure mcp.json for AI Integration

{
  "mcpServers": {
    "vector_mcp": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "vector-mcp",
        "vector-mcp"
      ],
      "env": {
        "DATABASE_TYPE": "chromadb",                   // Optional
        "COLLECTION_NAME": "memory",                   // Optional
        "DOCUMENT_DIRECTORY": "/home/user/Documents/"  // Optional
      },
      "timeout": 300000
    }
  }
}
Installation Instructions:

Install Python Package

python -m pip install vector-mcp

PGVector dependencies

python -m pip install vector-mcp[pgvector]

All

python -m pip install vector-mcp[all]

or

uv pip install --upgrade vector-mcp[all]
Repository Owners:

GitHub followers GitHub User's stars

Special shoutouts to Microsoft Autogen V1 ♥️

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

vector_mcp-0.1.10.tar.gz (52.4 kB view details)

Uploaded Source

Built Distribution

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

vector_mcp-0.1.10-py3-none-any.whl (70.2 kB view details)

Uploaded Python 3

File details

Details for the file vector_mcp-0.1.10.tar.gz.

File metadata

  • Download URL: vector_mcp-0.1.10.tar.gz
  • Upload date:
  • Size: 52.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for vector_mcp-0.1.10.tar.gz
Algorithm Hash digest
SHA256 4abcd4985a021f85d40a9c600e67f5465b72816c9a9b402c3328a290c6b19773
MD5 fbed01ef3d50e655b8ab89856b2cffcb
BLAKE2b-256 4f2d91c6547c68c94d91daa7326e6628b7eba3c6294e4460f0918e37bc4b1fcd

See more details on using hashes here.

File details

Details for the file vector_mcp-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: vector_mcp-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 70.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for vector_mcp-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 b874a4917a80409a1b813b622b97752fd6fbc8c3cad36f563c2d45c5b24c051f
MD5 47fce176c62464a0440933891ab837f7
BLAKE2b-256 0d6b860a133ffb0b550ae45d7246bedc81f0efb91e11ed3afff0f8d3c68ea180

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