feat(MCP): [2/5] Add search-records tool to RedisVL MCP

.gitignore

@@ -189,6 +189,9 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
+# Codex
+.codex/
+
 # PyCharm
 #  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore

docs/api/index.md

@@ -23,5 +23,6 @@ reranker
 cache
 message_history
 router
+cli
 ```
 

docs/user_guide/cli.ipynb

@@ -12,7 +12,9 @@
     "\n",
     "Before running this notebook, be sure to\n",
     "1. Have installed ``redisvl`` and have that environment active for this notebook.\n",
-    "2. Have a running Redis instance with Redis Search enabled"
+    "2. Have a running Redis instance with Redis Search enabled\n",
+    "\n",
+    "For complete command syntax and options, see the [CLI Reference](../api/cli.rst)."
    ]
   },
   {

docs/user_guide/how_to_guides/index.md

@@ -36,6 +36,11 @@ How-to guides are **task-oriented** recipes that help you accomplish specific go
 - [Choose a Storage Type](../05_hash_vs_json.ipynb) -- Hash vs JSON formats and nested data
 :::
 
+:::{grid-item-card} 💻 CLI Operations
+
+- [Manage Indices with the CLI](../cli.ipynb) -- create, inspect, and delete indices from your terminal
+:::
+
 ::::
 
 ## Quick Reference
@@ -53,6 +58,7 @@ How-to guides are **task-oriented** recipes that help you accomplish specific go
 | Improve search accuracy | [Rerank Search Results](../06_rerankers.ipynb) |
 | Optimize index performance | [Optimize Indexes with SVS-VAMANA](../09_svs_vamana.ipynb) |
 | Decide on storage format | [Choose a Storage Type](../05_hash_vs_json.ipynb) |
+| Manage indices from terminal | [Manage Indices with the CLI](../cli.ipynb) |
 
 ```{toctree}
 :hidden:

pyproject.toml

@@ -35,6 +35,10 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
+mcp = [
+    "fastmcp>=2.0.0 ; python_version >= '3.10'",
+    "pydantic-settings>=2.0",
+]
 mistralai = ["mistralai>=1.0.0"]
 openai = ["openai>=1.1.0"]
 nltk = ["nltk>=3.8.1,<4"]

redisvl/cli/index.py

@@ -30,13 +30,6 @@ def __init__(self):
         parser = argparse.ArgumentParser(usage=self.usage)
 
         parser.add_argument("command", help="Subcommand to run")
-        parser.add_argument(
-            "-f",
-            "--format",
-            help="Output format for info command",
-            type=str,
-            default="rounded_outline",
-        )
         parser = add_index_parsing_options(parser)
 
         args = parser.parse_args(sys.argv[2:])

redisvl/cli/stats.py

@@ -6,7 +6,6 @@
 from redisvl.index import SearchIndex
 from redisvl.schema.schema import IndexSchema
 from redisvl.utils.log import get_logger
-from redisvl.utils.utils import lazy_import
 
 logger = get_logger("[RedisVL]")
 
@@ -42,10 +41,6 @@ class Stats:
 
     def __init__(self):
         parser = argparse.ArgumentParser(usage=self.usage)
-
-        parser.add_argument(
-            "-f", "--format", help="Output format", type=str, default="rounded_outline"
-        )
         parser = add_index_parsing_options(parser)
         args = parser.parse_args(sys.argv[2:])
         try:
@@ -61,7 +56,7 @@ def stats(self, args: Namespace):
             rvl stats -i <index_name> | -s <schema_path>
         """
         index = self._connect_to_index(args)
-        _display_stats(index.info(), output_format=args.format)
+        _display_stats(index.info())
 
     def _connect_to_index(self, args: Namespace) -> SearchIndex:
         # connect to redis
@@ -85,7 +80,7 @@ def _connect_to_index(self, args: Namespace) -> SearchIndex:
         return index
 
 
-def _display_stats(index_info, output_format="rounded_outline"):
+def _display_stats(index_info):
     # Extracting the statistics
     stats_data = [(key, str(index_info.get(key))) for key in STATS_KEYS]
 

redisvl/extensions/cache/base.py

@@ -5,13 +5,13 @@
 """
 
 from collections.abc import Mapping
-from typing import Any, Dict, Optional, Union
+from typing import Any, Dict, Optional
 
 from redis import Redis  # For backwards compatibility in type checking
 from redis.cluster import RedisCluster
 
 from redisvl.redis.connection import RedisConnectionFactory
-from redisvl.types import AsyncRedisClient, SyncRedisClient, SyncRedisCluster
+from redisvl.types import AsyncRedisClient, SyncRedisClient
 
 
 class BaseCache:

redisvl/extensions/router/semantic.py

@@ -1,5 +1,5 @@
 from pathlib import Path
-from typing import Any, Dict, List, Mapping, Optional, Type, Union
+from typing import Any, Dict, List, Optional, Type, Union
 
 import redis.commands.search.reducers as reducers
 import yaml

redisvl/index/index.py

@@ -286,9 +286,13 @@ def _validate_query(self, query: BaseQuery) -> None:
     def _validate_hybrid_query(self, query: Any) -> None:
         """Validate that a hybrid query can be executed."""
         try:
-            from redis.commands.search.hybrid_result import HybridResult
+            from redis.commands.search.hybrid_result import (  # noqa: F401
+                HybridResult as _HybridResult,
+            )
 
             from redisvl.query.hybrid import HybridQuery
+
+            del _HybridResult  # Only imported to check availability
         except (ImportError, ModuleNotFoundError):
             raise ImportError(_HYBRID_SEARCH_ERROR_MESSAGE)
 
@@ -894,14 +898,14 @@ def load(
                 batch_size=batch_size,
                 validate=self._validate_on_load,
             )
-        except SchemaValidationError as e:
+        except SchemaValidationError:
             # Log the detailed validation error with actionable information
             logger.error("Data validation failed during load operation")
             raise
-        except Exception as e:
+        except Exception as exc:
             # Wrap other errors as general RedisVL errors
             logger.exception("Error while loading data to Redis")
-            raise RedisVLError(f"Failed to load data: {str(e)}") from e
+            raise RedisVLError(f"Failed to load data: {str(exc)}") from exc
 
     def fetch(self, id: str) -> Optional[Dict[str, Any]]:
         """Fetch an object from Redis by id.
@@ -1840,14 +1844,14 @@ def add_field(d):
                 batch_size=batch_size,
                 validate=self._validate_on_load,
             )
-        except SchemaValidationError as e:
+        except SchemaValidationError:
             # Log the detailed validation error with actionable information
             logger.error("Data validation failed during load operation")
             raise
-        except Exception as e:
+        except Exception as exc:
             # Wrap other errors as general RedisVL errors
             logger.exception("Error while loading data to Redis")
-            raise RedisVLError(f"Failed to load data: {str(e)}") from e
+            raise RedisVLError(f"Failed to load data: {str(exc)}") from exc
 
     async def fetch(self, id: str) -> Optional[Dict[str, Any]]:
         """Asynchronously etch an object from Redis by id. The id is typically

redisvl/index/storage.py

@@ -1,16 +1,5 @@
 from collections.abc import Collection
-from typing import (
-    Any,
-    Awaitable,
-    Callable,
-    Dict,
-    Iterable,
-    List,
-    Optional,
-    Tuple,
-    Union,
-    cast,
-)
+from typing import Any, Callable, Dict, Iterable, List, Optional, Tuple, Union
 
 from pydantic import BaseModel, ValidationError
 from redis import __version__ as redis_version

redisvl/mcp/__init__.py

@@ -0,0 +1,14 @@
+from redisvl.mcp.config import MCPConfig, load_mcp_config
+from redisvl.mcp.errors import MCPErrorCode, RedisVLMCPError, map_exception
+from redisvl.mcp.server import RedisVLMCPServer
+from redisvl.mcp.settings import MCPSettings
+
+__all__ = [
+    "MCPConfig",
+    "MCPErrorCode",
+    "MCPSettings",
+    "RedisVLMCPError",
+    "RedisVLMCPServer",
+    "load_mcp_config",
+    "map_exception",
+]