Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| MCP_MODE | No | Communication mode for the MCP server. | stdio |
| PROJECT_ROOTS | No | Environment variable for project roots. High priority configuration. | |
| LOCALNEST_CONFIG | No | Path to the LocalNest configuration file. | ~/.localnest/config/localnest.config.json |
| LOCALNEST_DB_PATH | No | SQLite database path. | ~/.localnest/data/localnest.db |
| LOCALNEST_EMBED_DIMS | No | Embedding vector dimensions. | 384 |
| LOCALNEST_INDEX_PATH | No | JSON index path. | ~/.localnest/data/localnest.index.json |
| LOCALNEST_EMBED_MODEL | No | Embedding model name. | Xenova/all-MiniLM-L6-v2 |
| LOCALNEST_INDEX_BACKEND | No | Index backend to use: 'sqlite-vec' or 'json'. | sqlite-vec |
| LOCALNEST_EMBED_PROVIDER | No | Embedding backend provider. | xenova |
| LOCALNEST_MEMORY_BACKEND | No | Memory backend: 'auto', 'node-sqlite', or 'sqlite3'. | auto |
| LOCALNEST_MEMORY_DB_PATH | No | SQLite memory database path. | ~/.localnest/data/localnest.memory.db |
| LOCALNEST_MEMORY_ENABLED | No | Enable local memory subsystem. | false |
| LOCALNEST_RERANKER_MODEL | No | Cross-encoder reranker model name. | Xenova/ms-marco-MiniLM-L-6-v2 |
| LOCALNEST_UPDATE_PACKAGE | No | npm package name to check/update. | localnest-mcp |
| LOCALNEST_EMBED_CACHE_DIR | No | Embedding model cache path. | ~/.localnest/cache |
| LOCALNEST_VECTOR_MAX_FILES | No | Max files per index run. | 20000 |
| LOCALNEST_VECTOR_MAX_TERMS | No | Max terms per chunk. | 80 |
| LOCALNEST_RERANKER_PROVIDER | No | Reranker backend provider. | xenova |
| LOCALNEST_RERANKER_CACHE_DIR | No | Reranker model cache path. | ~/.localnest/cache |
| LOCALNEST_VECTOR_CHUNK_LINES | No | Lines per index chunk. | 60 |
| LOCALNEST_MEMORY_AUTO_CAPTURE | No | Allow background event ingest to promote memories automatically. | false |
| LOCALNEST_MEMORY_CONSENT_DONE | No | Indicates setup memory consent was already collected. | false |
| LOCALNEST_SQLITE_VEC_EXTENSION | No | Optional custom native extension path for sqlite-vec. If unset, no native extension load is attempted. | |
| LOCALNEST_VECTOR_CHUNK_OVERLAP | No | Overlap between chunks. | 15 |
| LOCALNEST_UPDATE_CHECK_INTERVAL_MINUTES | No | Refresh interval for npm update checks. | 120 |
| LOCALNEST_UPDATE_FAILURE_BACKOFF_MINUTES | No | Retry interval when npm check fails. | 15 |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| localnest_server_status | Return runtime status and active configuration summary for this MCP server. |
| localnest_health | Return a compact runtime health summary for fast smoke checks. |
| localnest_usage_guide | Return concise best-practice guidance for users and AI agents using this MCP. |
| localnest_update_status | Check npm for the latest localnest-mcp version on the selected channel (cached, default every 120 minutes). |
| localnest_update_self | Update localnest-mcp globally via npm and sync bundled skill. Supports stable, beta, or explicit version targets. Requires explicit user approval. |
| localnest_task_context | Bundle runtime status, memory state, and relevant recall for a non-trivial task in one call. |
| localnest_memory_status | Return local memory feature status, consent state, and backend compatibility. |
| localnest_memory_recall | Recall the most relevant local memories for a task or query. |
| localnest_capture_outcome | Capture a meaningful task outcome into the memory event pipeline with a simpler payload. |
| localnest_memory_list | List stored memories with optional scope and kind filters. |
| localnest_memory_get | Fetch one stored memory with revision history. |
| localnest_memory_store | Store a durable local memory entry. |
| localnest_memory_update | Update a stored memory entry and append a revision. |
| localnest_memory_delete | Delete a stored memory entry and all of its revisions. |
| localnest_memory_capture_event | Ingest a background work event and auto-promote meaningful events into durable memory. |
| localnest_memory_events | List recently captured memory events and whether they were promoted into durable memory. |
| localnest_memory_suggest_relations | Find semantically similar memory entries that could be linked to a given memory. Uses dense embeddings (all-MiniLM-L6-v2) when available, falls back to token overlap. Returns candidates ranked by similarity without creating any relations — use localnest_memory_add_relation to confirm. |
| localnest_memory_add_relation | Link two memory entries with a named relation. Use to build a traversable knowledge graph (e.g. "depends_on", "contradicts", "supersedes", "related"). |
| localnest_memory_remove_relation | Remove a relation between two memory entries. |
| localnest_memory_related | Return all memory entries linked to a given memory ID, traversing the knowledge graph one hop in both directions. |
| localnest_list_roots | List configured local roots available to this MCP server. |
| localnest_list_projects | List first-level project directories under a root. |
| localnest_project_tree | Return a compact tree of files/directories for a project path. |
| localnest_index_status | Return local semantic index status and metadata. |
| localnest_embed_status | Return active embedding backend/model status and vector-search readiness. |
| localnest_index_project | Build or refresh semantic index for a project or across all roots. |
| localnest_search_files | Search file paths and names matching a query. Use this first when looking for a module, feature, or component by name (e.g. "sso", "payment", "auth"). Much faster than content search for module discovery, and handles cases where the keyword only appears in file/directory names. |
| localnest_search_code | Search text across files under a project/root and return matching lines. Best for exact symbol names, imports, or known identifiers. Use use_regex=true for patterns (e.g. "async\s+function\s+get\w+"). Use context_lines to include surrounding lines with each match. |
| localnest_search_hybrid | Run lexical + semantic retrieval and return RRF-ranked results. |
| localnest_get_symbol | Look up symbol definitions/exports by name using fast regex search. |
| localnest_find_usages | Find call sites and import usages of a symbol by name. |
| localnest_read_file | Read a bounded chunk of a file with line numbers. |
| localnest_summarize_project | Return a high-level summary of a project directory. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |