Skip to content

docs(MCP): [5/5] add RedisVL MCP server and documentation#547

Open
vishal-bala wants to merge 2 commits intofeat/RAAE-1399-mcp-clifrom
docs/RAAE-1532-mcp-docs
Open

docs(MCP): [5/5] add RedisVL MCP server and documentation#547
vishal-bala wants to merge 2 commits intofeat/RAAE-1399-mcp-clifrom
docs/RAAE-1532-mcp-docs

Conversation

@vishal-bala
Copy link
Copy Markdown
Collaborator

@vishal-bala vishal-bala commented Mar 27, 2026

Summary

  • Add a RedisVL MCP server, CLI entrypoint, configuration models, error handling, filter parsing, and search-records / upsert-records tools
  • Document how to run and configure MCP, including a new concepts page, a how-to guide, README updates, installation notes, and aligned spec examples
  • Cover the pain point of reimplementing Redis retrieval logic in each MCP client by exposing an existing Redis index through a stable, configuration-owned tool surface
  • Add unit and integration coverage for startup, config validation, search, upsert, filters, settings, and CLI behavior

Note

Low Risk
Documentation-only changes that add MCP guidance and adjust spec examples/contract details; low risk aside from potentially confusing users if CLI/config semantics are misdocumented.

Overview
Adds end-user documentation for running RedisVL as an MCP server: README updates (install redisvl[mcp], rvl mcp usage, read-only mode) plus new docs pages for MCP concepts and a detailed how-to with config, tool contracts, and troubleshooting.

Updates docs navigation and installation guidance to surface MCP, and aligns the MCP specs/examples by removing search_type from requests, moving read-only control to CLI/env, and clarifying upsert embedding behavior (no embed_text_field; always uses runtime.default_embed_text_field when embedding is needed).

Written by Cursor Bugbot for commit 6ffa14a. This will update automatically on new commits. Configure here.

@jit-ci
Copy link
Copy Markdown

jit-ci bot commented Mar 27, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

@vishal-bala vishal-bala changed the base branch from main to feat/RAAE-1399-mcp-cli March 30, 2026 15:50
@vishal-bala vishal-bala marked this pull request as ready for review March 30, 2026 15:50
@vishal-bala vishal-bala self-assigned this Mar 30, 2026
@vishal-bala vishal-bala changed the title feat: add RedisVL MCP server and documentation docs(MCP): add RedisVL MCP server and documentation Mar 30, 2026
@vishal-bala vishal-bala added the auto:documentation Changes only affect the documentation label Mar 30, 2026
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f9f02b01ed

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +83 to +85
attrs:
dims: 1536
datatype: float32
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Include required vector algorithm in schema_overrides example

This schema_overrides example omits algorithm, but RedisVL requires vector attrs to include it when constructing the effective schema. In the exact scenario where overrides are needed (older FT.INFO output missing vector attrs), this config will fail startup during schema validation (FieldFactory.pick_vector_field_type raises "Must provide algorithm param for the vector field" in redisvl/schema/fields.py). Please include algorithm here (and typically distance_metric) so the documented override path is runnable.

Useful? React with 👍 / 👎.

@vishal-bala vishal-bala changed the title docs(MCP): add RedisVL MCP server and documentation docs(MCP): [5/5] add RedisVL MCP server and documentation Apr 2, 2026
Copy link
Copy Markdown
Collaborator

@nkanu17 nkanu17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
May need an example in user_guides or ai-resources!


+++
LLM Caching • Filtering • Vectorizers • Reranking
LLM Caching • Filtering • MCP • Reranking
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dethroned

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto:documentation Changes only affect the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants