minirag-mcp
mcpkey · packageio.github.sfrangulov/minirag-mcp · v0.6.1
Local-first RAG MCP server: hybrid search over a folder of your own documents
run it
on your own machines, one way per deploy methodgenerated from the record, not tested yet
# once, as root:
# as_mcp DIR COMMAND...: runs COMMAND as the mcp user in DIR, its home, sandboxed as the
# units are: a package's install scripts can write to DIR only, as the server later can
as_mcp() {
local dir="$1"; shift
systemd-run --quiet --wait --pipe --collect --uid=mcp --gid=mcp \
-p WorkingDirectory="$dir" -p Environment=HOME="$dir" -p ReadWritePaths="$dir" \
-p NoNewPrivileges=true -p ProtectSystem=strict -p ProtectHome=true -p PrivateTmp=true \
-- "$@" </dev/null
}
install -d -m 0750 -o mcp -g mcp /var/lib/mcp/minirag
# minirag: its packages, installed whole before its unit starts (no session installs)
systemctl stop mcp-my-agent-minirag.service 2>/dev/null || true
as_mcp /var/lib/mcp/minirag uv tool install minirag-mcp==0.6.1
as_mcp /var/lib/mcp/minirag uv tool install mcp-proxy
#!/usr/bin/env bash
# minirag (io.github.sfrangulov/minirag-mcp), recipe baremetal (generated).
# Generated by Hub for toolset "my-agent"; started by mcp-my-agent-minirag.service.
set -euo pipefail
export HOST=127.0.0.1 PORT=8101
exec uvx mcp-proxy --host 127.0.0.1 --port 8101 --pass-environment -- uvx minirag-mcp==0.6.1
[Unit]
Description=MCP server minirag (toolset my-agent), generated by Hub
After=network-online.target
Wants=network-online.target
[Service]
Type=simple
User=mcp
Group=mcp
EnvironmentFile=/etc/mcp/my-agent.env
Environment=HOME=/var/lib/mcp/minirag
WorkingDirectory=/var/lib/mcp/minirag
ExecStart=/opt/mcp/my-agent/bin/minirag.sh
Restart=on-failure
RestartSec=5
NoNewPrivileges=true
ProtectSystem=strict
ProtectHome=true
PrivateTmp=true
ReadWritePaths=/var/lib/mcp/minirag
[Install]
WantedBy=multi-user.target
generated from the record, not tested yet
docker run --rm -p 127.0.0.1:8101:8000 -e BASE_DIR -e BASE_DIRS -e DB_PATH -e CACHE_DIR -e MODEL_NAME -e MAX_FILE_SIZE -e CHUNK_TOKEN_BUDGET -e RAG_HYBRID_WEIGHT -e RAG_GROUPING -e RAG_MAX_DISTANCE -e RAG_MAX_FILES -e RAG_INSTRUCTIONS_APPEND -e ALLOW_PRIVATE_URLS ghcr.io/astral-sh/uv:python3.12-bookworm-slim sh -c 'uvx mcp-proxy --host 0.0.0.0 --port 8000 --pass-environment -- uvx minirag-mcp==0.6.1'
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-18T20:25:07+00:00).
# Each package server runs behind a stdio->HTTP bridge and listens on localhost only.
# cp .env.example .env # fill the ${VAR}s
# docker compose up -d && bash smoke.sh
# Remote servers are not here: clients reach them directly (see clients/).
name: mcp-my-agent
services:
minirag:
image: ghcr.io/astral-sh/uv:python3.12-bookworm-slim
command:
- sh
- -c
- uvx mcp-proxy --host 0.0.0.0 --port 8000 --pass-environment -- uvx minirag-mcp==0.6.1
ports:
- 127.0.0.1:8101:8000
volumes:
- uv-cache:/root/.cache/uv
healthcheck:
test:
- CMD
- python3
- -c
- import urllib.request; urllib.request.urlopen('http://127.0.0.1:8000/status')
interval: 30s
timeout: 5s
retries: 5
start_period: 2m
restart: unless-stopped
environment:
BASE_DIR: ${BASE_DIR}
BASE_DIRS: ${BASE_DIRS}
DB_PATH: ${DB_PATH}
CACHE_DIR: ${CACHE_DIR}
MODEL_NAME: ${MODEL_NAME}
MAX_FILE_SIZE: ${MAX_FILE_SIZE}
CHUNK_TOKEN_BUDGET: ${CHUNK_TOKEN_BUDGET}
RAG_HYBRID_WEIGHT: ${RAG_HYBRID_WEIGHT}
RAG_GROUPING: ${RAG_GROUPING}
RAG_MAX_DISTANCE: ${RAG_MAX_DISTANCE}
RAG_MAX_FILES: ${RAG_MAX_FILES}
RAG_INSTRUCTIONS_APPEND: ${RAG_INSTRUCTIONS_APPEND}
ALLOW_PRIVATE_URLS: ${ALLOW_PRIVATE_URLS}
volumes:
npm-cache: {}
uv-cache: {}
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-18T20:25:07+00:00).
# kubectl create namespace mcp
# kubectl -n mcp create secret generic mcp-credentials --from-env-file=.env
# kubectl apply -f kubernetes.yaml
# Services are cluster-internal: <name>.mcp.svc.cluster.local:8000/mcp. Put an ingress
# with auth in front before exposing any of them.
apiVersion: v1
kind: Namespace
metadata:
name: mcp
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: minirag
namespace: mcp
labels: &id001
app: minirag
spec:
replicas: 1
selector:
matchLabels: *id001
template:
metadata:
labels: *id001
spec:
containers:
- name: minirag
image: ghcr.io/astral-sh/uv:python3.12-bookworm-slim
ports:
- containerPort: 8000
name: http
env:
- name: BASE_DIR
valueFrom:
secretKeyRef:
name: mcp-credentials
key: BASE_DIR
- name: BASE_DIRS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: BASE_DIRS
- name: DB_PATH
valueFrom:
secretKeyRef:
name: mcp-credentials
key: DB_PATH
- name: CACHE_DIR
valueFrom:
secretKeyRef:
name: mcp-credentials
key: CACHE_DIR
- name: MODEL_NAME
valueFrom:
secretKeyRef:
name: mcp-credentials
key: MODEL_NAME
- name: MAX_FILE_SIZE
valueFrom:
secretKeyRef:
name: mcp-credentials
key: MAX_FILE_SIZE
- name: CHUNK_TOKEN_BUDGET
valueFrom:
secretKeyRef:
name: mcp-credentials
key: CHUNK_TOKEN_BUDGET
- name: RAG_HYBRID_WEIGHT
valueFrom:
secretKeyRef:
name: mcp-credentials
key: RAG_HYBRID_WEIGHT
- name: RAG_GROUPING
valueFrom:
secretKeyRef:
name: mcp-credentials
key: RAG_GROUPING
- name: RAG_MAX_DISTANCE
valueFrom:
secretKeyRef:
name: mcp-credentials
key: RAG_MAX_DISTANCE
- name: RAG_MAX_FILES
valueFrom:
secretKeyRef:
name: mcp-credentials
key: RAG_MAX_FILES
- name: RAG_INSTRUCTIONS_APPEND
valueFrom:
secretKeyRef:
name: mcp-credentials
key: RAG_INSTRUCTIONS_APPEND
- name: ALLOW_PRIVATE_URLS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: ALLOW_PRIVATE_URLS
args:
- sh
- -c
- uvx mcp-proxy --host 0.0.0.0 --port 8000 --pass-environment -- uvx minirag-mcp==0.6.1
readinessProbe:
httpGet:
path: /status
port: http
initialDelaySeconds: 10
---
apiVersion: v1
kind: Service
metadata:
name: minirag
namespace: mcp
spec:
selector:
app: minirag
ports:
- port: 8000
targetPort: http
name: http
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-18T20:25:07+00:00).
# Credentials come from the Secret 'mcp-credentials' (kubectl create secret generic ... --from-env-file=.env).
# Each server under `servers` is one Deployment + Service; the keys after it configure
# upstream charts a worker verified.
servers:
minirag:
enabled: true
replicas: 1
port: 8000
path: /mcp
container:
name: minirag
image: ghcr.io/astral-sh/uv:python3.12-bookworm-slim
ports:
- containerPort: 8000
name: http
env:
- name: BASE_DIR
valueFrom:
secretKeyRef:
name: mcp-credentials
key: BASE_DIR
- name: BASE_DIRS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: BASE_DIRS
- name: DB_PATH
valueFrom:
secretKeyRef:
name: mcp-credentials
key: DB_PATH
- name: CACHE_DIR
valueFrom:
secretKeyRef:
name: mcp-credentials
key: CACHE_DIR
- name: MODEL_NAME
valueFrom:
secretKeyRef:
name: mcp-credentials
key: MODEL_NAME
- name: MAX_FILE_SIZE
valueFrom:
secretKeyRef:
name: mcp-credentials
key: MAX_FILE_SIZE
- name: CHUNK_TOKEN_BUDGET
valueFrom:
secretKeyRef:
name: mcp-credentials
key: CHUNK_TOKEN_BUDGET
- name: RAG_HYBRID_WEIGHT
valueFrom:
secretKeyRef:
name: mcp-credentials
key: RAG_HYBRID_WEIGHT
- name: RAG_GROUPING
valueFrom:
secretKeyRef:
name: mcp-credentials
key: RAG_GROUPING
- name: RAG_MAX_DISTANCE
valueFrom:
secretKeyRef:
name: mcp-credentials
key: RAG_MAX_DISTANCE
- name: RAG_MAX_FILES
valueFrom:
secretKeyRef:
name: mcp-credentials
key: RAG_MAX_FILES
- name: RAG_INSTRUCTIONS_APPEND
valueFrom:
secretKeyRef:
name: mcp-credentials
key: RAG_INSTRUCTIONS_APPEND
- name: ALLOW_PRIVATE_URLS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: ALLOW_PRIVATE_URLS
args:
- sh
- -c
- uvx mcp-proxy --host 0.0.0.0 --port 8000 --pass-environment -- uvx minirag-mcp==0.6.1
readinessProbe:
httpGet:
path: /status
port: http
initialDelaySeconds: 10
# helm install my-agent helm/my-agent -n mcp
in the cloud
one click: the provider's deploy form opens filled in, in your own account- koyeb
-
The form opens with CHANGE_ME for each value you supply: BASE_DIR, BASE_DIRS, DB_PATH, CACHE_DIR, MODEL_NAME, MAX_FILE_SIZE, CHUNK_TOKEN_BUDGET, RAG_HYBRID_WEIGHT, RAG_GROUPING, RAG_MAX_DISTANCE, RAG_MAX_FILES, RAG_INSTRUCTIONS_APPEND, ALLOW_PRIVATE_URLS. Fill them in before you deploy.
Clients connect to the service's https://…koyeb.app address plus /mcp.
- azure
-
A Container Apps environment with one app per server, each with HTTPS ingress and one replica. The portal asks for each value you supply as a secure parameter; the deployment's outputs list the endpoints.
connect to it
copy what your client needsuvx minirag-mcp==0.6.1 # env: BASE_DIR, BASE_DIRS, DB_PATH, CACHE_DIR, MODEL_NAME, MAX_FILE_SIZE, CHUNK_TOKEN_BUDGET, RAG_HYBRID_WEIGHT, RAG_GROUPING, RAG_MAX_DISTANCE, RAG_MAX_FILES, RAG_INSTRUCTIONS_APPEND, ALLOW_PRIVATE_URLS
{
"mcpServers": {
"minirag": {
"command": "uvx",
"args": [
"minirag-mcp==0.6.1"
],
"env": {
"BASE_DIR": "${BASE_DIR}",
"BASE_DIRS": "${BASE_DIRS}",
"DB_PATH": "${DB_PATH}",
"CACHE_DIR": "${CACHE_DIR}",
"MODEL_NAME": "${MODEL_NAME}",
"MAX_FILE_SIZE": "${MAX_FILE_SIZE}",
"CHUNK_TOKEN_BUDGET": "${CHUNK_TOKEN_BUDGET}",
"RAG_HYBRID_WEIGHT": "${RAG_HYBRID_WEIGHT}",
"RAG_GROUPING": "${RAG_GROUPING}",
"RAG_MAX_DISTANCE": "${RAG_MAX_DISTANCE}",
"RAG_MAX_FILES": "${RAG_MAX_FILES}",
"RAG_INSTRUCTIONS_APPEND": "${RAG_INSTRUCTIONS_APPEND}",
"ALLOW_PRIVATE_URLS": "${ALLOW_PRIVATE_URLS}"
}
}
}
}
#!/usr/bin/env bash
# Registers every server with Claude Code (run once; `claude mcp list` to check).
set -euo pipefail
set -a; [ -f .env ] && source .env; set +a
claude mcp add minirag -e "BASE_DIR=${BASE_DIR}" -e "BASE_DIRS=${BASE_DIRS}" -e "DB_PATH=${DB_PATH}" -e "CACHE_DIR=${CACHE_DIR}" -e "MODEL_NAME=${MODEL_NAME}" -e "MAX_FILE_SIZE=${MAX_FILE_SIZE}" -e "CHUNK_TOKEN_BUDGET=${CHUNK_TOKEN_BUDGET}" -e "RAG_HYBRID_WEIGHT=${RAG_HYBRID_WEIGHT}" -e "RAG_GROUPING=${RAG_GROUPING}" -e "RAG_MAX_DISTANCE=${RAG_MAX_DISTANCE}" -e "RAG_MAX_FILES=${RAG_MAX_FILES}" -e "RAG_INSTRUCTIONS_APPEND=${RAG_INSTRUCTIONS_APPEND}" -e "ALLOW_PRIVATE_URLS=${ALLOW_PRIVATE_URLS}" -- uvx minirag-mcp==0.6.1
{
"mcpServers": {
"minirag": {
"command": "uvx",
"args": [
"minirag-mcp==0.6.1"
],
"env": {
"BASE_DIR": "${BASE_DIR}",
"BASE_DIRS": "${BASE_DIRS}",
"DB_PATH": "${DB_PATH}",
"CACHE_DIR": "${CACHE_DIR}",
"MODEL_NAME": "${MODEL_NAME}",
"MAX_FILE_SIZE": "${MAX_FILE_SIZE}",
"CHUNK_TOKEN_BUDGET": "${CHUNK_TOKEN_BUDGET}",
"RAG_HYBRID_WEIGHT": "${RAG_HYBRID_WEIGHT}",
"RAG_GROUPING": "${RAG_GROUPING}",
"RAG_MAX_DISTANCE": "${RAG_MAX_DISTANCE}",
"RAG_MAX_FILES": "${RAG_MAX_FILES}",
"RAG_INSTRUCTIONS_APPEND": "${RAG_INSTRUCTIONS_APPEND}",
"ALLOW_PRIVATE_URLS": "${ALLOW_PRIVATE_URLS}"
}
}
}
}
{
"servers": {
"minirag": {
"type": "stdio",
"command": "uvx",
"args": [
"minirag-mcp==0.6.1"
],
"env": {
"BASE_DIR": "${BASE_DIR}",
"BASE_DIRS": "${BASE_DIRS}",
"DB_PATH": "${DB_PATH}",
"CACHE_DIR": "${CACHE_DIR}",
"MODEL_NAME": "${MODEL_NAME}",
"MAX_FILE_SIZE": "${MAX_FILE_SIZE}",
"CHUNK_TOKEN_BUDGET": "${CHUNK_TOKEN_BUDGET}",
"RAG_HYBRID_WEIGHT": "${RAG_HYBRID_WEIGHT}",
"RAG_GROUPING": "${RAG_GROUPING}",
"RAG_MAX_DISTANCE": "${RAG_MAX_DISTANCE}",
"RAG_MAX_FILES": "${RAG_MAX_FILES}",
"RAG_INSTRUCTIONS_APPEND": "${RAG_INSTRUCTIONS_APPEND}",
"ALLOW_PRIVATE_URLS": "${ALLOW_PRIVATE_URLS}"
}
}
}
}
name: my-agent target: local servers: - hub: io.github.sfrangulov/minirag-mcp
- not probed yet: tools unpinned, ingest lists them
tools
Not probed yetThe tools appear once the hub or its worker has listed this entry. Running it still works: your client lists them on first start.