Skip to main content

Sari - Local Search MCP Server

Project description

Sari (사리)

🇰🇷 한국어 가이드 (Korean Guide)

Sari is a high-performance Local Code Search Agent implementing the Model Context Protocol (MCP). It empowers AI assistants (like Claude, Cursor, Codex) to efficiently navigate, understand, and search large codebases without sending code to external servers.

Key Features:

  • Fast Indexing: SQLite FTS5 + AST-based symbol extraction.
  • 🔍 Smart Search: Hybrid ranking (Keyword + Symbol structure).
  • 🧠 Code Intelligence: Call graphs, snippets management, and domain context archiving.
  • 🔒 Local & Secure: All data remains on your machine. No external API dependency.

🚀 Installation & Setup

Sari supports automatic installation via MCP configuration (Recommended) or manual installation via pip.

Option 1: Automatic Installation (Recommended)

Add the following configuration to your MCP client (Cursor, Claude Desktop, etc.). Sari will be automatically installed (via pip) and updated upon launch.

🍎 macOS / Linux

Cursor / Claude Desktop Config:

{
  "mcpServers": {
    "sari": {
      "command": "bash",
      "args": [
        "-lc",
        "export PATH=$PATH:/usr/local/bin:/opt/homebrew/bin:$HOME/.local/bin && (curl -fsSL https://raw.githubusercontent.com/BaeCheolHan/sari/main/install.py | python3 - -y || true) && exec ~/.local/share/sari/bootstrap.sh auto"
      ],
      "env": {
        "SARI_WORKSPACE_ROOT": "/path/to/your/project",
        "SARI_RESPONSE_COMPACT": "1"
      }
    }
  }
}

🪟 Windows (PowerShell)

Cursor / Claude Desktop Config:

{
  "mcpServers": {
    "sari": {
      "command": "powershell",
      "args": [
        "-NoProfile",
        "-ExecutionPolicy", "Bypass",
        "-Command",
        "irm https://raw.githubusercontent.com/BaeCheolHan/sari/main/install.py | python - -y; & $env:LOCALAPPDATA\\sari\\bootstrap.bat auto"
      ],
      "env": {
        "SARI_WORKSPACE_ROOT": "C:\\path\\to\\your\\project",
        "SARI_RESPONSE_COMPACT": "1"
      }
    }
  }
}

Gemini CLI

Gemini CLI reads MCP servers from settings.json. Add a Sari entry to your Gemini settings and restart the CLI. citeturn0search1turn0search5

Settings file locations:

  • macOS/Linux: ~/.gemini/settings.json
  • Windows: %USERPROFILE%\.gemini\settings.json citeturn0search5
{
  "mcpServers": {
    "sari": {
      "command": "bash",
      "args": [
        "-lc",
        "export PATH=$PATH:/usr/local/bin:/opt/homebrew/bin:$HOME/.local/bin && (curl -fsSL https://raw.githubusercontent.com/BaeCheolHan/sari/main/install.py | python3 - -y || true) && exec ~/.local/share/sari/bootstrap.sh auto"
      ],
      "env": {
        "SARI_WORKSPACE_ROOT": "/path/to/your/project",
        "SARI_RESPONSE_COMPACT": "1"
      }
    }
  }
}

Option 2: Manual Installation (Pip)

If you prefer to manage the package manually:

# Install from PyPI
pip install sari

# Run MCP Server
python3 -m sari auto

⚙️ Configuration Reference

Variables are categorized into Installation-time and Runtime settings.

How to set environment variables

  • MCP Client: Add to the env block of your MCP server configuration.
  • CLI: Prefix the command, e.g., SARI_ENGINE_MODE=sqlite sari status.
"env": {
  "SARI_WORKSPACE_ROOT": "/path/to/project",
  "SARI_ENGINE_TOKENIZER": "cjk"
}

A. Installation & Bootstrapping

Settings affecting the installation scripts (install.py, bootstrap.sh).

Variable Description Default
XDG_DATA_HOME Custom data directory for installation. Sari installs to $XDG_DATA_HOME/sari. ~/.local/share
SARI_SKIP_INSTALL Set 1 to skip automatic pip install/upgrade on startup. Useful for development or offline usage. 0
SARI_NO_INTERACTIVE Set 1 to disable interactive prompts during installation (assumes 'yes'). 0

B. System & Runtime

Settings controlling the MCP server loop and behaviors. Add these to your env config.

1. Core & System

Essential settings for basic operation. (SARI_ prefix is also supported for backward compatibility).

Variable Description Default
SARI_WORKSPACE_ROOT (Required) Absolute path to the project root. Auto-detected if omitted. Auto-detect
SARI_ROOTS_JSON JSON array of strings for multiple workspace roots. e.g., ["/path/a", "/path/b"] -
SARI_DB_PATH Custom path for the SQLite database file. ~/.local/share/sari/data/<hash>/index.db
SARI_CONFIG Path to a specific config file to load. ~/.config/sari/config.json
SARI_RESPONSE_COMPACT Minify JSON responses (pack format) to save LLM tokens. Set 0 for pretty-print debugging. 1 (Enabled)
SARI_FORMAT Output format for CLI tools. pack (text-based) or json. pack

2. Search Engine

Settings to tune search quality and backend behavior.

Variable Description Default
SARI_ENGINE_MODE Search backend. embedded uses Tantivy (faster, smart ranking), sqlite uses FTS5 (slower, fallback). embedded
SARI_ENGINE_TOKENIZER Tokenizer strategy. auto (detects), cjk (optimized for KR/CN/JP), latin (standard). auto
SARI_ENGINE_AUTO_INSTALL Automatically install engine binaries (Tantivy) if missing. 1 (Enabled)
SARI_ENGINE_SUGGEST_FILES File count threshold to suggest upgrading to Tantivy engine in status checks. 10000
SARI_LINDERA_DICT_PATH Path to custom Lindera dictionary for CJK tokenization (Advanced). -

3. Indexing & Performance

Fine-tune resource usage and concurrency.

Variable Description Default
SARI_COALESCE_SHARDS Number of lock shards for indexing concurrency. Increase for massive repos with frequent changes. 16
SARI_PARSE_TIMEOUT_SECONDS Timeout per file parsing in seconds. Set 0 to disable timeout. Prevents parser hangs. 0
SARI_PARSE_TIMEOUT_WORKERS Worker threads for parsing with timeout. 2
SARI_MAX_PARSE_BYTES Max file size to attempt parsing (bytes). Larger files are skipped or sampled. 16MB
SARI_MAX_AST_BYTES Max file size to attempt AST extraction (bytes). 8MB
SARI_GIT_CHECKOUT_DEBOUNCE Seconds to wait after git checkout before starting bulk indexing. 3.0
SARI_FOLLOW_SYMLINKS Follow symbolic links during file scanning. Caution: May cause infinite loops if circular links exist. 0 (Disabled)
SARI_READ_MAX_BYTES Max bytes returned by read_file tool. Prevents context overflow. 1MB

4. Network & Security

Connectivity settings for the daemon.

Variable Description Default
SARI_DAEMON_HOST Host address for the background daemon. 127.0.0.1
SARI_DAEMON_PORT TCP port for the daemon. 47779
SARI_HTTP_API_PORT Port for the HTTP API server (optional). 47777
SARI_ALLOW_NON_LOOPBACK Allow connections from non-localhost IPs. Security Risk: Only enable in trusted networks. 0 (Disabled)

5. Advanced / Debug

Developer options for debugging and plugin extension.

Variable Description Default
SARI_LOG_LEVEL Logging verbosity (DEBUG, INFO, WARNING, ERROR). INFO
SARI_DRYRUN_LINT Enable syntax checking (linting) in dry-run-diff. 0 (Disabled)
SARI_PERSIST_ROOTS Set 1 to persist detected roots to config.json. 0 (Disabled)
SARI_CALLGRAPH_PLUGIN Python module path for custom static analysis plugin. -
SARI_DLQ_POLL_SECONDS Interval to retry failed indexing tasks (Dead Letter Queue). 60

🛠️ Usage (MCP Tools)

Once connected, your AI assistant can use these tools:

Core Tools

  • search: Search for code or documentation using keywords or regex.
  • read_file: Read file content (optimized for large files).
  • list_files: List files in the repository.
  • search_symbols: Find classes, functions, or methods by name.
  • read_symbol: Read only the definition of a specific symbol (saves context).

Intelligence Tools

  • call_graph: Analyze function call relationships (upstream/downstream).
  • save_snippet / get_snippet: Save and retrieve important code blocks with tags.
  • archive_context / get_context: Store domain knowledge and design decisions.
  • grep_and_read: Search and read top N files in one go (Composite tool).

🩺 Troubleshooting

Check Status

You can check the daemon status and indexing progress:

# If installed automatically:
~/.local/share/sari/bootstrap.sh status

# If installed via pip:
sari status

sari status will automatically use the actual HTTP port recorded in .codex/tools/sari/data/server.json (workspace-local). The daemon port is discovered via the global registry at ~/.local/share/sari/server.json, so clients can reconnect without manual port changes.

If Daemon Port Is Busy

If you see a message like "Daemon already running" but things still don't work, another process may be using the default port.

# Try a different daemon port:
SARI_DAEMON_PORT=47790 sari daemon start -d

Run Daemon + HTTP Together

sari status talks to the HTTP server, so you should run the daemon and HTTP together. The daemon auto-starts HTTP for the current workspace.

# Start both (daemon will auto-start HTTP):
sari daemon start -d

# If you need a custom workspace:
SARI_WORKSPACE_ROOT=/path/to/workspace sari daemon start -d

Zero-Downtime Upgrade (Port Split)

You can run a new daemon+HTTP on different ports, switch clients, then stop the old one.

# Start new instance on alternate ports:
sari daemon start -d --daemon-port 47790 --http-port 47778

# Check new instance:
sari status --daemon-port 47790 --http-port 47778

Run Doctor

Diagnose issues with your environment or installation:

# If installed automatically:
~/.local/share/sari/bootstrap.sh doctor --auto-fix

# If installed via pip:
sari doctor --auto-fix

Update

Update Sari using the installer script:

curl -fsSL https://raw.githubusercontent.com/BaeCheolHan/sari/main/install.py | python3 - --update -y

After updating, restart the daemon to load the new version:

pkill -f "sari.mcp.daemon"
sari daemon start -d

The bootstrap script now starts a new daemon on a free port automatically to allow zero-downtime updates.

Uninstall

To remove Sari, indexed data, and default configs:

# macOS/Linux
curl -fsSL https://raw.githubusercontent.com/BaeCheolHan/sari/main/install.py | python3 - --uninstall

# Windows
irm https://raw.githubusercontent.com/BaeCheolHan/sari/main/install.py | python - --uninstall

To also remove workspace-local caches (if used), pass the workspace root:

curl -fsSL https://raw.githubusercontent.com/BaeCheolHan/sari/main/install.py | python3 - --uninstall --workspace-root /path/to/project

The uninstall command also scans your home directory for .codex/tools/sari caches and removes them (best effort).

If you set SARI_CONFIG or SARI_CONFIG to a custom path and want that file removed too, pass:

curl -fsSL https://raw.githubusercontent.com/BaeCheolHan/sari/main/install.py | python3 - --uninstall --force-config

📜 License

Apache License 2.0

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

sari-0.1.23.tar.gz (71.7 MB view details)

Uploaded Source

Built Distribution

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

sari-0.1.23-py3-none-any.whl (71.7 MB view details)

Uploaded Python 3

File details

Details for the file sari-0.1.23.tar.gz.

File metadata

  • Download URL: sari-0.1.23.tar.gz
  • Upload date:
  • Size: 71.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sari-0.1.23.tar.gz
Algorithm Hash digest
SHA256 b8f2294a9b9311dc7ec4d94ae9913d35e434ce409cc83928430c30f0c7d5ad1c
MD5 dd1a1ba700237b291c7de1457fba816a
BLAKE2b-256 a27c54c3fe3e3d83221048a528e23a1abbd3d5046f834a6e823f84f36457f80d

See more details on using hashes here.

File details

Details for the file sari-0.1.23-py3-none-any.whl.

File metadata

  • Download URL: sari-0.1.23-py3-none-any.whl
  • Upload date:
  • Size: 71.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sari-0.1.23-py3-none-any.whl
Algorithm Hash digest
SHA256 46a19e3dfc7150798fc99104bf0f991c7a1e8922729d964892cd3620dc193e66
MD5 dfe432ea4b9fbe8ac7c6386223b8e257
BLAKE2b-256 a36589f184a0960f86e4faf26d1045a752794f773a3ebefd596f5993e1ebf8bd

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