Skip to content

feat(mcp): add list-indexes discovery tool (RAAE-1605) - #630

Merged
vishal-bala merged 4 commits into
feature/raae-1603-mcp-multi-indexfrom
feature/raae-1605-list-indexes
Jul 1, 2026
Merged

feat(mcp): add list-indexes discovery tool (RAAE-1605)#630
vishal-bala merged 4 commits into
feature/raae-1603-mcp-multi-indexfrom
feature/raae-1605-list-indexes

Conversation

@vishal-bala

@vishal-bala vishal-bala commented Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Stacked on #629 (RAAE-1604). Review/merge that first; this PR targets the 1604 branch so the diff is scoped to the discovery tool.

Motivation

Once a single MCP server can expose multiple logical indexes (RAAE-1604), clients need a lightweight way to discover what's available so they can pick the right index instead of guessing. This PR (RAAE-1605) adds an always-registered, read-only list-indexes tool for exactly that, and it grounds discovery in the schema the server already inspected at startup rather than asking users to re-declare field metadata in config.

Implementation

The new tool (redisvl/mcp/tools/list_indexes.py) returns one entry per configured binding, in configured order: the logical id, an optional description, an upsert_available flag, the shared filterable fields, and — only when explicitly configured — a limits object. upsert_available is simply not effective_read_only, so it already reflects both the global --read-only flag and the per-index read_only policy resolved at startup. The fields list is built from the binding's effective (inspected + overridden) schema that already lives on its BindingRuntime, so the output stays consistent with what the index actually contains; the vector field and the configured default embed-source text field are omitted because they are implementation inputs rather than fields a client would filter on. The Redis index name (redis_name) is deliberately never exposed. Limits are included only when the operator set them explicitly — detected via the runtime model's model_fields_set — so defaults don't masquerade as deliberate overrides; per the contract this covers max_limit and max_upsert_records.

The tool is registered unconditionally during the server's tool registration (alongside search-records and the conditionally-registered upsert-records) and is gated by the same read scope as search when auth is enabled, since it is read-only.

  • Output is deterministic and ordered by configured binding.
  • No new configuration surface or settings are required.

Verification

  • mypy clean; black/isort formatted.
  • New unit coverage: field omission (vector + embed-source), description/limits inclusion rules, redis_name secrecy, read-only reflection, single- and multi-binding output, and tool registration.
  • New integration test starts a real two-binding server (one vector, one fulltext) and asserts the discovered fields come from the inspected schema and follow the omission rules.
  • Full MCP suite green: 178 unit + 45 integration (2 skipped on Redis-version gates) against Redis 8.

🤖 Generated with Claude Code


Note

Low Risk
Read-only discovery metadata with no new config; behavior is additive and gated like existing search tools when auth is enabled.

Overview
Adds a read-only list-indexes MCP tool so clients can discover logical indexes on multi-binding servers before calling search-records or upsert-records.

The tool is always registered during _register_tools (alongside search; upsert remains conditional). Each binding is returned in config order with id, optional description, upsert_available (not effective_read_only), filterable fields from the startup-inspected schema (vector and default embed-source text omitted), and limits only when max_limit / max_upsert_records were explicitly set. redis_name is never exposed; empty bindings raise RuntimeError like other pre-startup paths. When auth is on, the tool uses the same read scope as search.

Unit and integration tests cover payload rules, registration, and a two-binding startup scenario.

Reviewed by Cursor Bugbot for commit 45ce686. Bugbot is set up for automated code reviews on this repo. Configure here.

@jit-ci

jit-ci Bot commented Jun 16, 2026

Copy link
Copy Markdown

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

@vishal-bala

Copy link
Copy Markdown
Collaborator Author

CI tests are failing due to flaky issues being fixed by redis-developer/sql-redis#39

@vishal-bala
vishal-bala requested a review from nkanu17 June 25, 2026 10:05

@nkanu17 nkanu17 left a comment

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.

This generally looks great! I ran into one thing that specified in the comments, it is worth checking the auth access pattern across the tools.

Comment thread redisvl/mcp/tools/list_indexes.py Outdated
Comment thread redisvl/mcp/tools/list_indexes.py Outdated
@vishal-bala
vishal-bala requested a review from nkanu17 June 30, 2026 11:39
@vishal-bala
vishal-bala force-pushed the feature/raae-1604-config-runtime-model branch from 118b01d to bd2a28a Compare June 30, 2026 13:41

@nkanu17 nkanu17 left a comment

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.

lgtm

@vishal-bala
vishal-bala force-pushed the feature/raae-1605-list-indexes branch from e8d750c to 14bbdbf Compare June 30, 2026 20:11
Base automatically changed from feature/raae-1604-config-runtime-model to feature/raae-1603-mcp-multi-index June 30, 2026 20:12
vishal-bala and others added 3 commits June 30, 2026 22:16
Add an always-registered, read-only `list-indexes` MCP tool so clients can
enumerate the logical indexes a multi-index server exposes and choose the
right one before calling search-records or upsert-records.

For each configured binding the tool returns the logical id, an optional
description, whether upsert is available (reflecting both the global
--read-only flag and the per-index read_only policy), the shared filterable
fields, and any explicitly configured runtime limits. Fields are derived from
the binding's already-inspected effective schema rather than user-declared
metadata; the vector field and the configured default embed-source text field
are omitted because they are implementation inputs, not things a client
filters on. The Redis index name (redis_name) is never exposed. Limits are
surfaced only when explicitly set in config (detected via the runtime model's
model_fields_set), so the output reflects deliberate overrides rather than
defaults.

- New redisvl/mcp/tools/list_indexes.py with list_indexes() + register_list_indexes_tool().
- Registered unconditionally in the server's tool registration, alongside search/upsert.
- Output is deterministic and ordered by configured binding.
- TDD: unit coverage for field omission, description/limits inclusion rules,
  redis_name secrecy, read-only reflection, and registration; integration test
  verifying fields are derived from the inspected schema across a vector and a
  fulltext binding.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the opaque `rt: Any` parameters in list_indexes.py with the concrete
`BindingRuntime` type and the clearer name `binding_runtime`, and type the
`server` parameters as `RedisVLMCPServer` (via a TYPE_CHECKING import to avoid
the server<->tools import cycle). No behavior change.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ead (RAAE-1605)

Address review on list_indexes.py:

- Remove the `tool_list_indexes_description` override: that setting does not
  exist on MCPSettings (only tool_search/upsert_description do), so the getattr
  branch was always None and never fired. Pass the default description constant
  directly.
- Read the read scope as `auth_config.read_scope` (a typed field on
  MCPAuthConfig) instead of a silent `getattr(..., "read_scope", None)`. The
  old form would fail open — silently yielding None and skipping auth
  enforcement — if the field were ever renamed; direct access fails loud.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vishal-bala
vishal-bala force-pushed the feature/raae-1605-list-indexes branch from 14bbdbf to 2276985 Compare June 30, 2026 20:18

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 2276985. Configure here.

Comment thread redisvl/mcp/tools/list_indexes.py
…605)

list_indexes registered the tool instance-level, so it can still be called
before startup or after shutdown when _bindings is empty. Returning
{"indexes": []} there is misleading — a client reads it as "no indexes
configured" rather than "server not ready". Guard with the same
"MCP server has not been started" RuntimeError that resolve_binding raises.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vishal-bala

Copy link
Copy Markdown
Collaborator Author

Failing tests are because of the Redis 8.8 flakiness issue - proceeding with the merge

@vishal-bala
vishal-bala merged commit 6bd9d30 into feature/raae-1603-mcp-multi-index Jul 1, 2026
53 of 54 checks passed
@vishal-bala
vishal-bala deleted the feature/raae-1605-list-indexes branch July 1, 2026 09:41
vishal-bala added a commit that referenced this pull request Jul 2, 2026
## Motivation

With a single MCP server now able to expose multiple logical index
bindings ([RAAE-1604](https://redislabs.atlassian.net/browse/RAAE-1604))
and advertise them via `list-indexes`
([RAAE-1605](https://redislabs.atlassian.net/browse/RAAE-1605)), the
`search-records` tool still implicitly resolved the sole binding. On a
multi-binding server it had no way to say *which* index a query should
run against. This change
([RAAE-1606](https://redislabs.atlassian.net/browse/RAAE-1606)) makes
that routing explicit while keeping the public contract backwards-safe
for existing single-index callers.

The design goal is that v1 clients see no behavioral change: when
exactly one binding is configured and the caller omits `index`, the
request resolves to that binding exactly as before. Routing only becomes
mandatory once ambiguity exists. Query construction, validation,
pagination, filtering, and the configured search mode all remain owned
by the selected binding — this ticket adds only the selection and a
confirmation echo, not new query behavior.

## Implemented changes

`search-records` gains an optional `index` argument naming the logical
binding to query. Resolution flows through the shared `resolve_binding`
routing introduced in RAAE-1604, so the three cases fall out
consistently: an omitted `index` with one binding resolves to that
binding; an omitted `index` with multiple bindings returns
`invalid_request`; and an unknown id returns `invalid_request`. The
resolved logical id is echoed back as the `index` field of the response
payload so multi-index clients can confirm where a query actually ran.
All downstream work (limits, schema, vectorizer, search config)
continues to read from the resolved binding's runtime.

When multiple bindings are configured the tool description is ambiguous
about fields, so instead of emitting per-field filter hints it now
appends a short routing note directing the client to call `list-indexes`
first and pass the chosen id as `index`. Single-binding servers keep
their full schema-derived description unchanged.

Minor additional changes:

- The FastMCP wrapper exposes `index` as a tool parameter so MCP clients
can supply it.
- Unit coverage for default-to-sole-binding, named routing, unknown-id
rejection, the wrapper param, and the ambiguous-schema description note.
- Integration coverage for a two-binding server: routing to each named
binding, omitted-index rejection, unknown-id rejection, and
single-binding echo.

## Verification

- `make format` (isort + black) and mypy clean on changed files.
- Full MCP suite: **232 passed, 2 skipped** (Redis-version-gated) across
unit + integration.

## Stacking

This PR targets `feature/raae-1605-list-indexes` so its diff stays
scoped to search routing. Review/merge bottom-up:
[#629](#629) →
[#630](#630) → this PR.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

[RAAE-1604]:
https://redislabs.atlassian.net/browse/RAAE-1604?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[RAAE-1605]:
https://redislabs.atlassian.net/browse/RAAE-1605?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[RAAE-1606]:
https://redislabs.atlassian.net/browse/RAAE-1606?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Backward-compatible for single-index callers; changes are limited to
MCP search routing and an additive response field, with validation
delegated to existing `resolve_binding`.
> 
> **Overview**
> The MCP **`search-records`** tool now accepts an optional **`index`**
argument so clients can target a specific logical binding on multi-index
servers. Resolution goes through **`resolve_binding`**: omitting
**`index`** still works when only one binding exists; with multiple
bindings, **`index`** is required and unknown ids return
**`invalid_request`**.
> 
> Successful responses include a new **`index`** field with the resolved
binding id so callers can confirm routing. The FastMCP wrapper exposes
**`index`** as a tool parameter.
> 
> When the server has multiple indexes, the tool description skips
per-schema filter/return-field hints and instead tells clients to call
**`list-indexes`** and pass the chosen id as **`index`**. Single-index
servers keep the full schema-derived description.
> 
> Unit and integration tests cover named routing, omitted-index errors
on multi-binding setups, unknown-index rejection, single-binding echo
behavior, and the ambiguous-schema description.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
c2f30d5. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
vishal-bala added a commit that referenced this pull request Jul 2, 2026
…ds (RAAE-1607) (#632)

## Motivation

This completes the multi-index tool surface for the RedisVL MCP server.
After [RAAE-1606](https://redislabs.atlassian.net/browse/RAAE-1606)
taught `search-records` to route by logical index, `upsert-records`
([RAAE-1607](https://redislabs.atlassian.net/browse/RAAE-1607)) needs
the same explicit routing — but writes also carry a policy dimension
that reads do not. A single server can now host a mix of writable and
read-only bindings, and the tool must respect both the global
`--read-only` override and each binding's own `read_only` flag while
staying backwards-safe for existing single-index clients.

The design keeps single-index behavior identical: when one binding is
configured and `index` is omitted, the write resolves to that binding
exactly as before. Routing becomes mandatory only once multiple bindings
exist. Write enforcement happens at two complementary levels so the
contract is unambiguous: a server with no writable bindings should not
advertise the tool at all, while a server with some writable bindings
still needs to protect the read-only ones on a per-call basis.

## Implemented changes

`upsert-records` gains an optional `index` argument naming the logical
binding to write to, resolved through the shared `resolve_binding`
routing introduced in RAAE-1604. An omitted `index` with one binding
resolves to that binding; an omitted `index` with multiple bindings
returns `invalid_request`; and an unknown id returns `invalid_request`.
The resolved logical id is echoed back as the `index` field of the
response, and the selected binding's embedding, runtime limits, and
schema validation drive the rest of the write unchanged.

Write availability is enforced at two levels. The tool registration gate
is refined from "global read-only is off" to "at least one binding is
writable" — expressed via `effective_read_only`, which already folds in
both global read-only mode and a binding's own `read_only` policy — so
an all-read-only server does not expose `upsert-records` at all. When
the tool is registered, a per-call guard rejects writes to any
individual read-only binding with `invalid_request` *before* any
embedding or backend write occurs, so a writable server can still
protect specific indexes.

Minor additional changes:

- The FastMCP wrapper exposes `index` as a tool parameter.
- Unit coverage for default-to-sole-binding, named routing, unknown-id
rejection, read-only-binding rejection, the wrapper param, and both
registration-gate outcomes (any-writable exposes the tool; all-read-only
hides it).
- Integration coverage on a two-binding server (one writable vector
index, one read-only fulltext index): routing to the writable binding,
omitted-index rejection, unknown-id rejection, read-only-binding
rejection, and single-binding echo.

## Verification

- `make format` (isort + black) and mypy clean on changed files.
- Full MCP suite: **244 passed, 2 skipped** (Redis-version-gated) across
unit + integration.

## Stacking

This PR targets `feature/raae-1606-search-routing` so its diff stays
scoped to upsert routing + write policy. Review/merge bottom-up:
[#629](#629) →
[#630](#630) →
[#631](#631) → this PR.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

[RAAE-1606]:
https://redislabs.atlassian.net/browse/RAAE-1606?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[RAAE-1607]:
https://redislabs.atlassian.net/browse/RAAE-1607?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Medium Risk**
> Changes write routing and when the upsert tool is exposed on
multi-index servers; mistakes could allow writes to the wrong index or
hide/show the tool unexpectedly, though enforcement is fail-closed
before backend writes.
> 
> **Overview**
> **`upsert-records`** now accepts an optional **`index`** logical
binding id (via shared **`resolve_binding`**), matching multi-index
**`search-records`**: omit **`index`** when one binding is configured;
require it when several exist; reject unknown ids. Successful responses
include an **`index`** field naming the binding that was written.
> 
> Write policy is split between **tool advertisement** and **per-call
enforcement**. **`upsert-records`** is registered only when at least one
binding is writable (**`effective_read_only`** is false for some
binding), not merely when global read-only mode is off. Each call still
rejects writes to read-only bindings (**`FORBIDDEN`**, before embedding
or Redis load) with a clearer message naming the binding.
> 
> The FastMCP wrapper exposes **`index`** as a tool parameter. Unit and
integration tests cover routing, registration gating, and read-only
rejection.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
98aded7. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
vishal-bala added a commit that referenced this pull request Jul 2, 2026
## Motivation

The RedisVL MCP docs were written for the original single-index model
and still stated that "one server process binds to exactly one existing
Redis index." With multi-index support now implemented across
[RAAE-1604](https://redislabs.atlassian.net/browse/RAAE-1604)–[RAAE-1607](https://redislabs.atlassian.net/browse/RAAE-1607),
the user-facing documentation
([RAAE-1608](https://redislabs.atlassian.net/browse/RAAE-1608)) needs to
describe the new compatibility story without confusing existing
single-index users.

The guiding principle in the rewrite is that single-index remains the
simplest deployment and works exactly as before — callers never name an
index — while multi-index is presented as a formal, additive capability
layered on top via discovery (`list-indexes`) and explicit routing (the
`index` argument). No documentation still claims a server must bind to
exactly one index.

## Implemented changes

The concept doc ([concepts/mcp.md](docs/concepts/mcp.md)) now frames the
server as binding one *or several* logical indexes, each addressed by an
id, and adds an "Index Selection and Discovery" section covering the
optional `index` argument, the omitted-index and unknown-id rules, the
response echo, and discovery-first guidance. The "Single Index Binding"
section becomes "Single and Multiple Index Bindings," the read-only
section explains the two-level write policy (global `--read-only` vs
per-index `read_only`, folded into effective write availability), and
the tool surface gains a `list-indexes` subsection documenting its
minimal payload — filterable fields only, vector/embed-source fields
omitted, explicit-only limits, and `redis_name` never exposed.

The how-to guide
([how_to_guides/mcp.md](docs/user_guide/how_to_guides/mcp.md)) adds a
two-binding config example (a writable vector index alongside a
read-only fulltext index), an Index Selection subsection, a
`list-indexes` tool contract with a response example, and threads the
optional `index` argument through the `search-records` and
`upsert-records` argument lists and request/response examples. A
discovery-first multi-index flow is shown at the top of the search
examples, and the CLI/env-var notes are updated for per-index read-only
and the multi-index search description.

Minor additional changes:

- README MCP section and feature-table entry reworded from "an existing
Redis index" to "one or more existing Redis indexes," with
`list-indexes` and the discovery-first flow noted. (The README edit was
explicitly authorized for this ticket, overriding the repo's default
no-README-edits rule.)

## Verification

- `sphinx-build` (the `docs` dependency group) completes cleanly (exit
0). The only warnings are pre-existing and unrelated (upstream
`redis-py` docstrings and `index.md` heading levels); no warnings
reference the MCP pages, and no broken cross-reference/anchor warnings
were introduced.

## Stacking

This PR targets `feature/raae-1607-upsert-routing` and is the top of the
stack. Review/merge bottom-up:
[#629](#629) →
[#630](#630) →
[#631](#631) →
[#632](#632) → this PR.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

[RAAE-1604]:
https://redislabs.atlassian.net/browse/RAAE-1604?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[RAAE-1607]:
https://redislabs.atlassian.net/browse/RAAE-1607?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[RAAE-1608]:
https://redislabs.atlassian.net/browse/RAAE-1608?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Markdown-only changes with no runtime, API, or security behavior
modified.
> 
> **Overview**
> **Documentation-only** update aligning RedisVL MCP user-facing docs
with multi-index support: one server can bind **one or several** logical
indexes while **single-index deployments stay backward compatible**
(omit `index`).
> 
> **README** rewords MCP copy from a single index to one or more, and
notes **`list-indexes`**, discovery-first routing, and per-index tools.
> 
> **`docs/concepts/mcp.md`** reframes the model (per-index config,
all-or-nothing startup), adds **Index Selection and Discovery** (`index`
argument rules, response echo), expands **read-only** to global vs
per-index `read_only` and effective `upsert_available`, and documents
the **`list-indexes`** payload (minimal fields, no `redis_name`).
> 
> **`docs/user_guide/how_to_guides/mcp.md`** adds a **two-binding YAML
example**, **`list-indexes`** contract and examples, threads optional
**`index`** through search/upsert docs, a discovery-first flow, and
updates CLI/env notes for multi-index search tool descriptions.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
de2eb4f. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
vishal-bala added a commit that referenced this pull request Jul 3, 2026
## Overview

Rolls up the **RedisVL MCP multi-index server** epic
([RAAE-1603](https://redislabs.atlassian.net/browse/RAAE-1603)) into
`main`. A single MCP server can now expose **one or more** configured
Redis index bindings — with discovery (`list-indexes`), explicit
per-call routing (an optional `index` argument on
`search-records`/`upsert-records`), and per-index write policy — while
existing **single-index configs and callers behave exactly as before**.

## This is a roll-up — every change was already reviewed and merged

This PR introduces **no new code**. It is the aggregate of a stacked
series of per-ticket PRs, each reviewed and squash-merged into the
`feature/raae-1603-mcp-multi-index` collector branch:

- [#629](#629) — RAAE-1604:
config + runtime refactor (immutable `BindingRuntime`, per-binding
startup/teardown, `resolve_binding` routing, single global concurrency
semaphore)
- [#630](#630) — RAAE-1605:
`list-indexes` discovery tool
- [#631](#631) — RAAE-1606:
`search-records` index routing
- [#632](#632) — RAAE-1607:
`upsert-records` index routing + per-index write policy
- [#633](#633) — RAAE-1608:
concept/how-to/README docs

Each stacked PR was reviewed (human + Cursor Bugbot) and its threads
resolved before merge; this branch is the sum of those merges plus a
sync with `main`.

## Synced with `main`

The branch is up to date with `main`, including the recently merged MCP
security work — **Host/Origin header validation
([#643](#643 and the
**nltk drop
([#645](#645 — pulled
in via merge, so this PR's diff contains **only** the epic's own changes
(main's commits are in the merge base).

## Security review

A security review of the epic diff was run (auth scope enforcement,
read-only/write policy, index routing, info leakage, injection,
config/vectorizer resolution). **No findings** — tokenless HTTP is
rejected upstream by the SDK auth middleware, scopes and read-only
policy are enforced at both registration and per-call, routing is
confined to configured bindings, and `redis_name` is never exposed by
`list-indexes`.

## Verification

- Full MCP unit + integration suite: **283 passed / 1 skipped** on
`redis:8.2` (now runs without nltk).
- `mypy` clean; `black`/`isort` clean.
- Backward compatibility covered by dedicated tests (single-binding
defaults, omitted-`index` behavior, unchanged response contract aside
from the additive `index` echo).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

[RAAE-1603]:
https://redislabs.atlassian.net/browse/RAAE-1603?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Medium Risk**
> Changes MCP server startup, routing, and write boundaries across
bindings; single-index behavior is preserved but multi-index
misconfiguration or routing errors could affect production assistants.
> 
> **Overview**
> **Multi-index MCP server** — One process can expose several logical
index bindings from YAML `indexes`, each with its own schema inspection,
search config, vectorizer, and runtime limits. Startup is
all-or-nothing: any binding failure prevents the server from starting.
> 
> **Routing and discovery** — New **`list-indexes`** tool enumerates
logical ids, filterable fields, `upsert_available`, and optional limits
(without exposing `redis_name`). **`search-records`** and
**`upsert-records`** accept an optional **`index`** argument; responses
echo the resolved id. With a single binding, omitting `index` still
works; with multiple bindings, omitting or using an unknown id returns
`invalid_request`.
> 
> **Write policy** — Global `--read-only` / `REDISVL_MCP_READ_ONLY` plus
per-binding **`read_only: true`** combine into
**`effective_read_only`**. `upsert-records` is registered only if at
least one binding is writable; writes to a read-only binding fail with
**`forbidden`** before Redis is touched.
> 
> **Implementation** — Config drops the “exactly one index” rule and
adds **`description`** / **`read_only`** on bindings. Server state moves
to per-binding **`BindingRuntime`** and **`resolve_binding()`**; removed
single-index helpers like `get_index()`. Search tool descriptions omit
per-schema hints when multiple indexes are configured and point clients
to `list-indexes`.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
553e55f. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ahsd-coder pushed a commit to ahsd-coder/LLM-Smart-Cache that referenced this pull request Jul 7, 2026
## Overview

Rolls up the **RedisVL MCP multi-index server** epic
([RAAE-1603](https://redislabs.atlassian.net/browse/RAAE-1603)) into
`main`. A single MCP server can now expose **one or more** configured
Redis index bindings — with discovery (`list-indexes`), explicit
per-call routing (an optional `index` argument on
`search-records`/`upsert-records`), and per-index write policy — while
existing **single-index configs and callers behave exactly as before**.

## This is a roll-up — every change was already reviewed and merged

This PR introduces **no new code**. It is the aggregate of a stacked
series of per-ticket PRs, each reviewed and squash-merged into the
`feature/raae-1603-mcp-multi-index` collector branch:

- [#629](redis/redis-vl-python#629) — RAAE-1604:
config + runtime refactor (immutable `BindingRuntime`, per-binding
startup/teardown, `resolve_binding` routing, single global concurrency
semaphore)
- [#630](redis/redis-vl-python#630) — RAAE-1605:
`list-indexes` discovery tool
- [#631](redis/redis-vl-python#631) — RAAE-1606:
`search-records` index routing
- [#632](redis/redis-vl-python#632) — RAAE-1607:
`upsert-records` index routing + per-index write policy
- [#633](redis/redis-vl-python#633) — RAAE-1608:
concept/how-to/README docs

Each stacked PR was reviewed (human + Cursor Bugbot) and its threads
resolved before merge; this branch is the sum of those merges plus a
sync with `main`.

## Synced with `main`

The branch is up to date with `main`, including the recently merged MCP
security work — **Host/Origin header validation
([#643](redis/redis-vl-python#643 and the
**nltk drop
([#645](redis/redis-vl-python#645 — pulled
in via merge, so this PR's diff contains **only** the epic's own changes
(main's commits are in the merge base).

## Security review

A security review of the epic diff was run (auth scope enforcement,
read-only/write policy, index routing, info leakage, injection,
config/vectorizer resolution). **No findings** — tokenless HTTP is
rejected upstream by the SDK auth middleware, scopes and read-only
policy are enforced at both registration and per-call, routing is
confined to configured bindings, and `redis_name` is never exposed by
`list-indexes`.

## Verification

- Full MCP unit + integration suite: **283 passed / 1 skipped** on
`redis:8.2` (now runs without nltk).
- `mypy` clean; `black`/`isort` clean.
- Backward compatibility covered by dedicated tests (single-binding
defaults, omitted-`index` behavior, unchanged response contract aside
from the additive `index` echo).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

[RAAE-1603]:
https://redislabs.atlassian.net/browse/RAAE-1603?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Medium Risk**
> Changes MCP server startup, routing, and write boundaries across
bindings; single-index behavior is preserved but multi-index
misconfiguration or routing errors could affect production assistants.
> 
> **Overview**
> **Multi-index MCP server** — One process can expose several logical
index bindings from YAML `indexes`, each with its own schema inspection,
search config, vectorizer, and runtime limits. Startup is
all-or-nothing: any binding failure prevents the server from starting.
> 
> **Routing and discovery** — New **`list-indexes`** tool enumerates
logical ids, filterable fields, `upsert_available`, and optional limits
(without exposing `redis_name`). **`search-records`** and
**`upsert-records`** accept an optional **`index`** argument; responses
echo the resolved id. With a single binding, omitting `index` still
works; with multiple bindings, omitting or using an unknown id returns
`invalid_request`.
> 
> **Write policy** — Global `--read-only` / `REDISVL_MCP_READ_ONLY` plus
per-binding **`read_only: true`** combine into
**`effective_read_only`**. `upsert-records` is registered only if at
least one binding is writable; writes to a read-only binding fail with
**`forbidden`** before Redis is touched.
> 
> **Implementation** — Config drops the “exactly one index” rule and
adds **`description`** / **`read_only`** on bindings. Server state moves
to per-binding **`BindingRuntime`** and **`resolve_binding()`**; removed
single-index helpers like `get_index()`. Search tool descriptions omit
per-schema hints when multiple indexes are configured and point clients
to `list-indexes`.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
553e55f4e93b306b643e3b8aca157e7a40a1497b. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants