Merge pull request #682 from FalkorDB/dvirdukhan/mcp-t12-auto-init

feat(mcp): auto-init — ensure FalkorDB + opt-in auto-index (T12)

Author: DvirDukhan

api/mcp/auto_init.py

@@ -0,0 +1,242 @@
+"""Zero-config startup helpers for the MCP server (T12).
+
+Two automation behaviours:
+
+1. :func:`ensure_falkordb` — at server boot, ping FalkorDB; if it's
+   unreachable on a localhost host, shell out to ``cgraph ensure-db``
+   (a subprocess, so the CLI's JSON stdout can't pollute the MCP
+   server's own stdio transport) to spin up the Docker container.
+
+2. :func:`maybe_auto_index` — when ``CODE_GRAPH_AUTO_INDEX=true`` is set
+   (opt-in, off by default), index the current working directory into a
+   per-branch graph so the agent doesn't have to call ``index_repo``
+   first. Only indexes when the target graph is empty, stays within
+   ``ALLOWED_ANALYSIS_DIR`` when configured, and is idempotent within a
+   single process — the second call for the same ``(project, branch)``
+   is a no-op. The server runs it off the startup path (a daemon thread)
+   so indexing a large repo never blocks the stdio handshake.
+
+Both are deliberately conservative: ensure-db only acts on localhost
+hosts, and auto-index requires explicit opt-in because indexing a
+large repo can take minutes.
+"""
+
+from __future__ import annotations
+
+import logging
+import os
+import subprocess
+from pathlib import Path
+from typing import Iterable, Optional
+
+
+logger = logging.getLogger(__name__)
+
+
+_LOCAL_HOSTS = {"localhost", "127.0.0.1", "::1"}
+_AUTO_INDEXED: set[tuple[str, str]] = set()
+
+
+# ---------------------------------------------------------------------------
+# ensure_falkordb
+# ---------------------------------------------------------------------------
+
+
+def _falkordb_reachable(host: str, port: int, timeout: float = 1.0) -> bool:
+    """Reachability via a Redis ``PING`` — not a bare TCP connect.
+
+    A successful socket connection doesn't prove the listener is actually
+    FalkorDB/Redis (or that it's finished starting up), so we issue a ``PING``
+    using the same auth env (`FALKORDB_USERNAME`/`FALKORDB_PASSWORD`) the rest
+    of the app uses; any failure means "not reachable".
+    """
+    import redis
+
+    client = None
+    try:
+        client = redis.Redis(
+            host=host,
+            port=port,
+            username=os.getenv("FALKORDB_USERNAME") or None,
+            password=os.getenv("FALKORDB_PASSWORD") or None,
+            socket_connect_timeout=timeout,
+        )
+        return bool(client.ping())
+    except Exception:
+        return False
+    finally:
+        if client is not None:
+            try:
+                client.close()
+            except Exception:
+                pass
+
+
+def ensure_falkordb() -> dict:
+    """Make sure FalkorDB is reachable; bootstrap Docker if not.
+
+    Returns a small status dict so the caller can log it. Never raises —
+    the goal is to start the MCP server even if the bootstrap fails;
+    individual tools will then surface their own errors.
+    """
+    host = os.getenv("FALKORDB_HOST", "localhost")
+    try:
+        port = int(os.getenv("FALKORDB_PORT", "6379"))
+    except ValueError:
+        return {"status": "error", "message": "invalid FALKORDB_PORT"}
+    if not 1 <= port <= 65535:
+        return {
+            "status": "error",
+            "message": f"FALKORDB_PORT must be between 1 and 65535, got {port}",
+        }
+
+    if _falkordb_reachable(host, port):
+        return {"status": "ok", "host": host, "port": port, "action": "none"}
+
+    if host not in _LOCAL_HOSTS:
+        return {
+            "status": "error",
+            "host": host,
+            "port": port,
+            "message": "FalkorDB unreachable; auto-start only supports localhost",
+        }
+
+    logger.info("FalkorDB unreachable on %s:%s — running `cgraph ensure-db`", host, port)
+    try:
+        # Subprocess so the CLI's stdout (which prints JSON) doesn't pollute
+        # the MCP server's own stdio transport.
+        result = subprocess.run(
+            ["cgraph", "ensure-db"],
+            capture_output=True,
+            text=True,
+            check=False,
+        )
+    except FileNotFoundError:
+        return {"status": "error", "message": "cgraph CLI not on PATH"}
+
+    return {
+        "status": "ok" if result.returncode == 0 else "error",
+        "host": host,
+        "port": port,
+        "action": "started",
+        "stdout": result.stdout.strip(),
+        "stderr": result.stderr.strip(),
+    }
+
+
+# ---------------------------------------------------------------------------
+# maybe_auto_index
+# ---------------------------------------------------------------------------
+
+
+def _truthy(val: Optional[str]) -> bool:
+    return (val or "").strip().lower() in {"1", "true", "yes", "on"}
+
+
+def _detect_branch(cwd: Path) -> str:
+    """Best-effort current-branch detection. Falls back to ``_default``."""
+    try:
+        result = subprocess.run(
+            ["git", "rev-parse", "--abbrev-ref", "HEAD"],
+            cwd=str(cwd),
+            capture_output=True,
+            text=True,
+            check=False,
+        )
+        if result.returncode == 0:
+            branch = result.stdout.strip()
+            # A detached HEAD reports the literal "HEAD"; treat it (and an
+            # empty result) as the default branch — matching
+            # api.project.detect_branch — so we never create a graph named
+            # code:<project>:HEAD.
+            if branch and branch != "HEAD":
+                return branch
+    except FileNotFoundError:
+        pass
+    return "_default"
+
+
+def maybe_auto_index(
+    cwd: Optional[Path] = None,
+    *,
+    project: Optional[str] = None,
+    branch: Optional[str] = None,
+) -> dict:
+    """If opt-in env var is set, index ``cwd`` into the per-branch graph.
+
+    Caches "already auto-indexed this session" per ``(project, branch)``
+    in the module-level :data:`_AUTO_INDEXED` set so subsequent calls
+    are no-ops.
+    """
+    if not _truthy(os.getenv("CODE_GRAPH_AUTO_INDEX")):
+        return {"status": "skipped", "reason": "CODE_GRAPH_AUTO_INDEX not set"}
+
+    cwd_path = (cwd or Path.cwd()).resolve()
+
+    # Honor the same sandbox boundary as /api/analyze_folder and the index_repo
+    # MCP tool: opting in to auto-index must not let the server index a path
+    # outside the configured allow-list.
+    allowed_root = os.getenv("ALLOWED_ANALYSIS_DIR")
+    if allowed_root:
+        allowed = Path(allowed_root).expanduser().resolve()
+        try:
+            cwd_path.relative_to(allowed)
+        except ValueError:
+            return {
+                "status": "skipped",
+                "reason": f"path {cwd_path} is outside ALLOWED_ANALYSIS_DIR={allowed}",
+                "path": str(cwd_path),
+            }
+
+    project_name = project or cwd_path.name
+    branch_name = branch or _detect_branch(cwd_path)
+
+    key = (project_name, branch_name)
+    if key in _AUTO_INDEXED:
+        return {"status": "skipped", "reason": "already auto-indexed", "key": key}
+
+    # Local imports so the MCP server can import this module without paying
+    # the analyzer-stack import cost at module load.
+    from api.analyzers.source_analyzer import SourceAnalyzer
+    from api.graph import Graph, compose_graph_name, graph_exists
+
+    # Only auto-index when the target graph is empty. If it already holds data
+    # (indexed by a previous run or an explicit index_repo) re-indexing would
+    # add minutes of latency and duplicate writes for no benefit.
+    graph_name = compose_graph_name(project_name, branch_name)
+    if graph_exists(graph_name):
+        try:
+            populated = Graph(project_name, branch=branch_name).stats().get(
+                "node_count", 0
+            ) > 0
+        except Exception:
+            populated = False
+        if populated:
+            _AUTO_INDEXED.add(key)
+            return {
+                "status": "skipped",
+                "reason": "graph already populated",
+                "project": project_name,
+                "branch": branch_name,
+            }
+
+    logger.info("Auto-indexing %s @ %s into code:%s:%s", cwd_path, branch_name, project_name, branch_name)
+    graph = Graph(project_name, branch=branch_name)
+    SourceAnalyzer().analyze_local_folder(str(cwd_path), graph)
+
+    _AUTO_INDEXED.add(key)
+    return {
+        "status": "indexed",
+        "project": project_name,
+        "branch": branch_name,
+        "path": str(cwd_path),
+    }
+
+
+def reset_auto_index_cache(keys: Optional[Iterable[tuple[str, str]]] = None) -> None:
+    """Drop the auto-index session cache. Tests only."""
+    if keys is None:
+        _AUTO_INDEXED.clear()
+    else:
+        for k in keys:
+            _AUTO_INDEXED.discard(k)

api/mcp/server.py

@@ -9,8 +9,12 @@
 
 from __future__ import annotations
 
+import logging
+
 from mcp.server.fastmcp import FastMCP
 
+logger = logging.getLogger(__name__)
+
 app: FastMCP = FastMCP("code-graph")
 
 # Register tools on import so both direct ``import api.mcp.server`` and the
@@ -19,11 +23,43 @@
 from . import tools  # noqa: F401, E402
 
 
+def _start_background_auto_index() -> None:
+    """Run opt-in auto-index off the startup path.
+
+    Indexing a large repo can take minutes; doing it synchronously before
+    ``app.run`` would block the MCP stdio handshake until it finished. A daemon
+    thread keeps the server responsive immediately — the analyzer logs to
+    stderr only, so it can't corrupt the stdio JSON-RPC stream. ``maybe_auto_index``
+    is a no-op when ``CODE_GRAPH_AUTO_INDEX`` is unset and caches success so the
+    work happens at most once per ``(project, branch)``.
+    """
+    import threading
+
+    from .auto_init import maybe_auto_index
+
+    def _run() -> None:
+        try:
+            maybe_auto_index()
+        except Exception:  # never let a background failure take down the server
+            logger.exception("background auto-index failed")
+
+    threading.Thread(target=_run, name="cgraph-auto-index", daemon=True).start()
+
+
 def main() -> None:
     """Run the MCP server over stdio.
 
-    Console-script entry point for ``cgraph-mcp``.
+    Console-script entry point for ``cgraph-mcp``. Ensures FalkorDB is
+    reachable (bootstrapping the Docker container if needed) before
+    serving, then kicks off opt-in auto-indexing (via
+    ``CODE_GRAPH_AUTO_INDEX``) in the background so a freshly-cloned user
+    gets an indexed CWD without manual ``index_repo`` — without blocking
+    the stdio handshake.
     """
+    from .auto_init import ensure_falkordb
+
+    ensure_falkordb()
+    _start_background_auto_index()
     app.run(transport="stdio")