spec(MCP): Add specification for RedisVL MCP server (only for review; do not merge)#531
Closed
vishal-bala wants to merge 7 commits intomainfrom
Closed
spec(MCP): Add specification for RedisVL MCP server (only for review; do not merge)#531vishal-bala wants to merge 7 commits intomainfrom
vishal-bala wants to merge 7 commits intomainfrom
Conversation
🛡️ Jit Security Scan Results
✅ No security findings were detected in this PR
Security scan by Jit
|
vishal-bala
force-pushed
the
feat/RAAE-1395-redisvl-mcp
branch
from
2f58b0f to
1d1e5cc
Compare
Collaborator
Author
|
I've updated the specification based on the feedback from our review session. Here a couple of key points:
|
vishal-bala
added a commit
that referenced
this pull request
Apr 10, 2026
) This PR is an aggregation of changes reviewed in the following PRs: - #531 - #532 - #539 - #540 - #544 - #547 <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Medium Risk** > Adds a new MCP server surface area that performs schema inspection, embedding, and optional write operations against Redis, increasing operational and correctness risk despite extensive validation and tests. Optional dependency gating and Python-version checks reduce impact on core installs but the new server path could affect Redis access patterns and resource lifecycle. > > **Overview** > Adds an optional **RedisVL MCP server** that binds to one existing Redis Search index and exposes a stable tool contract for `search-records` and (unless *read-only*) `upsert-records`, driven entirely by a YAML config. > > Introduces new MCP configuration/settings loading with env var substitution, schema inspection plus `schema_overrides`, reserved-field and capability validation (including native vs fallback hybrid search), plus guarded concurrency/timeouts and deterministic error mapping. Updates the `rvl` CLI and docs/README/installation to support `redisvl[mcp]` (Python 3.10+) and adds comprehensive unit/integration tests; also tweaks filter type hints and ignores `.codex/`. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 6e2fe5b. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY -->
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR (not to be merged) introduces a specification document for the RedisVL MCP framework. The goal is to have a clear design document to guide agentic development on this feature.
Note
Low Risk
Documentation-only change that adds draft specification and example materials; no runtime behavior, packaging, or security-sensitive code is modified.
Overview
Adds a draft RedisVL MCP server spec (
spec/MCP.md) defining the planned MCP tool contracts (search-records,upsert-records), configuration shape/validation rules, lifecycle expectations (schema inspection + overrides, concurrency/timeouts), error codes, and an implementation/testing plan.Adds a companion production narrative (
spec/MCP-production-example.md) with an enterprise-style deployment sketch, sample YAML config, and example vector/hybrid search requests to help reviewers evaluate the spec in a realistic scenario.Written by Cursor Bugbot for commit 1ad61cd. This will update automatically on new commits. Configure here.