Skip to content

Add Redis integration entry#1777

Merged
koverholt merged 20 commits into
google:mainfrom
nkanu17:feat/add-redis-integration
May 20, 2026
Merged

Add Redis integration entry#1777
koverholt merged 20 commits into
google:mainfrom
nkanu17:feat/add-redis-integration

Conversation

@nkanu17
Copy link
Copy Markdown
Contributor

@nkanu17 nkanu17 commented May 19, 2026

Summary

Adds an integration catalog entry for adk-redis, the Python package that provides Redis-backed ADK integrations. New page at /integrations/redis/ and a new card on the catalog grid.

The integration covers four surfaces:

  • Search tools (RedisVL-backed): RedisVectorSearchTool, RedisHybridSearchTool (native FT.HYBRID on Redis 8.4+ with aggregation fallback), RedisRangeSearchTool, RedisTextSearchTool, and RedisSQLSearchTool (SQL SELECT via redisvl[sql-redis]).
  • Sessions and long-term memory: RedisWorkingMemorySessionService and RedisLongTermMemoryService, implementing BaseSessionService / BaseMemoryService against Redis Agent Memory Server with auto-summarization and recency-boosted semantic search.
  • MCP toolsets: create_redisvl_mcp_toolset(...) for RedisVL's own MCP server (rvl mcp, three transports), and create_memory_mcp_toolset(...) for Agent Memory Server's MCP endpoint.
  • Semantic cache: RedisVLCacheProvider (self-hosted) and LangCacheProvider (managed via Redis LangCache).

Catalog tags ["data","mcp"] to match the closest peers (MongoDB, Pinecone, Chroma, Qdrant). Page structure follows the convention from the contribution guide and those existing entries.

Files changed

  • docs/integrations/redis.md (new)
  • docs/integrations/assets/redis.png (new, 460x460, Redis org cube mark)

Verified

  • mkdocs build --strict passes locally.
  • Page renders at /integrations/redis/.
  • Card appears on the /integrations/ catalog grid.

Notes

  • adk-redis is published on PyPI as adk-redis and supports Python 3.10+.

@koverholt koverholt self-assigned this May 19, 2026
Copy link
Copy Markdown
Collaborator

@koverholt koverholt left a comment

Choose a reason for hiding this comment

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

Thanks for the thorough integration page and contributing these integrations to ADK! I made a few small fixes. I also left inline comments about two features that appear to only exist in a feature branch upstream; let me know your preference on handling those.

Comment thread docs/integrations/redis.md Outdated
Comment thread docs/integrations/redis.md Outdated
@netlify
Copy link
Copy Markdown

netlify Bot commented May 19, 2026

Deploy Preview for adk-docs-preview ready!

Name Link
🔨 Latest commit 25fad3c
🔍 Latest deploy log https://app.netlify.com/projects/adk-docs-preview/deploys/6a0e2711a00f9e0007ca186d
😎 Deploy Preview https://deploy-preview-1777--adk-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

nkanu17 and others added 3 commits May 19, 2026 23:00
Adds an integration catalog entry for `adk-redis`
(https://github.com/redis-developer/adk-redis), the Python package
that provides Redis-backed ADK integrations:

- RedisVL-backed search tools (vector, hybrid, range, text, SQL),
  including native FT.HYBRID on Redis 8.4+
- Session and long-term memory services that implement
  BaseSessionService and BaseMemoryService against
  Redis Agent Memory Server
- An McpToolset helper for RedisVL's own MCP server (`rvl mcp`),
  alongside the existing Agent Memory Server MCP helper
- Self-hosted and managed (Redis LangCache) semantic cache providers

Built and previewed with `mkdocs build --strict`; the page renders at
/integrations/redis/ and appears on the catalog grid.
Per maintainer guidance on the PR review thread:

- Replace `create_redisvl_mcp_toolset(...)` (a third-party Python
  wrapper that adk-redis shipped briefly but does not ship in the
  released 0.0.5) with ADK's native `McpToolset` plus
  `StdioConnectionParams` + `StdioServerParameters(command="rvl", ...)`.
  Matches the pattern used by every other MCP catalog page
  (cartesia, chroma, mongodb, pinecone, qdrant).
- Add a `!!! note` admonition pointing readers to
  `/tools-custom/mcp-tools/` if they want to connect to the `rvl mcp`
  server from other ADK language SDKs.
- Rename the tab from "MCP toolset" to "RedisVL MCP server" and
  prepend a one-paragraph explanation.
- Update the surface table at the top: split the single "MCP toolsets"
  row into "RedisVL MCP" (native McpToolset against `rvl mcp`) and
  "AMS MCP toolset" (`create_memory_mcp_toolset`).
- Update the "Available tools" table: replace the
  `create_redisvl_mcp_toolset(...)` helper row with a description of
  the `rvl mcp` server's exposed tools and how to wire `McpToolset`
  to them.

Other clean-ups:
  - Drop the `pip install 'adk-redis[mcp-search]'` line; the extra was
    retired from adk-redis 0.0.5 along with the wrapper. Add a
    `pip install 'redisvl[mcp]>=0.18.2'` line for the MCP CLI.
  - Switch sample vectorizer to `redis/langcache-embed-v2`, matching
    the repo's runnable examples and the rest of the adk-redis docs.

Verified with `mkdocs build --strict` locally. The admonition renders;
the link to `/tools-custom/mcp-tools/` resolves.
@nkanu17 nkanu17 force-pushed the feat/add-redis-integration branch from bcc58c1 to 13ecf2e Compare May 20, 2026 03:03
@nkanu17 nkanu17 marked this pull request as ready for review May 20, 2026 03:04
The page previously used the Redis org GitHub avatar PNG (460x460,
cube mark). Swap to `Redis_Logo_Red_RGB.svg` from the official Redis
brand kit (sourced via redis/redis-vl-python), matching the logo used
in the adk-redis README hero. SVG is acceptable for catalog assets
(see goodmem.svg precedent).

Note: this asset is a wordmark (viewBox ~500x156), wider than peer
catalog cards which are mostly square. If it renders awkwardly on the
catalog grid, swap back to a square cube-mark variant.

- Add `docs/integrations/assets/redis.svg`.
- Update `catalog_icon` in `redis.md` frontmatter.
- Drop `docs/integrations/assets/redis.png`.

Verified with `mkdocs build --strict`.
@nkanu17
Copy link
Copy Markdown
Contributor Author

nkanu17 commented May 20, 2026

Thanks for the thorough integration page and contributing these integrations to ADK! I made a few small fixes. I also left inline comments about two features that appear to only exist in a feature branch upstream; let me know your preference on handling those.

@koverholt Thanks for your input, I made the changes you requested and also have the upstream synced now!

Just another note: we released a suite of new products just earlier this week, and this integration might evolve to capture those as well! Therefore, there might be another update/PR in the future! So assuming that's fine and I can create an update later on! Thank you for all your help!

Copy link
Copy Markdown
Collaborator

@koverholt koverholt left a comment

Choose a reason for hiding this comment

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

Thank you for the updates, this is looking great! I have one open question (see in-line comments) about the AMS MCP toolset and create_memory_mcp_toolset() functionality, happy to defer to your preference/edits to resolve that. Once that is resolved we should be good to merge.

Comment thread docs/integrations/redis.md Outdated
Comment thread docs/integrations/redis.md Outdated
@koverholt
Copy link
Copy Markdown
Collaborator

Just another note: we released a suite of new products just earlier this week, and this integration might evolve to capture those as well! Therefore, there might be another update/PR in the future! So assuming that's fine and I can create an update later on! Thank you for all your help!

Yes definitely! We welcome followup PRs to update or add functionality to this page as the integrations and product space evolve. And you have the option to split up functionality on separate pages if you need to keep things scoped to distinct or non-overlapping integrations/products/solutions. One example of that is the MLflow AI Gateway page and the separate MLflow Tracing page.

Remove create_memory_mcp_toolset() references from the overview table
and MCP tools table. This wrapper was removed from adk-redis in v0.0.6
(redis-developer/adk-redis#13). Users should use ADK's native McpToolset
with SseConnectionParams for Agent Memory Server MCP access.

Resolves comments from @koverholt on lines 29 and 239.
@nkanu17 nkanu17 marked this pull request as draft May 20, 2026 17:34
nkanu17 added 7 commits May 20, 2026 13:38
Add a separate code tab showing how to connect ADK's native McpToolset
to Agent Memory Server's MCP endpoint over SSE, based on the
fitness_coach_mcp example. Also add a corresponding row to the MCP
reference table. Update overview count to five ways.
Add a separate LangCache tab with accurate code snippet using
LangCacheProvider and LangCacheProviderConfig (cache_id, api_key,
server_url). No local vectorizer needed for the managed service.
Semantic caching is a cross-cutting optimization rather than a core
integration approach. Move the self-hosted (RedisVL) and managed
(LangCache) cache tabs out of 'Use with agent' into a dedicated
'## Semantic caching' section. Drop the cache row from the overview
table, leaving four core approaches.
mich-elle-luna pushed a commit to redis/docs that referenced this pull request May 20, 2026
adk-redis 0.0.5 shipped to PyPI today with several changes that
the redis.io ADK docs were behind on. This brings the docs to parity.

Drift fixed:

- `_index.md`: AMS Docker command bumped from `gemini-2.0-flash` to
  `gemini-2.5-flash`. Added a Linux note for `host.docker.internal`
  (it does not resolve by default on Linux). Added the
  `pip install adk-redis[sql]` and `pip install redisvl[mcp]>=0.18.2`
  install lines. Capabilities table now mentions the SQL tool and the
  `rvl mcp` server, and the example count goes from seven to nine.
- `search-tools.md`: page now describes FIVE search tools (the new
  `RedisSQLSearchTool` was missing). Added a SQL search section with
  a runnable snippet and the parameterized-query pattern. Added a
  "RedisVL MCP server" section showing ADK's native `McpToolset`
  wired to `rvl mcp` over stdio, following the maintainer guidance
  on `google/adk-docs#1777`. Bottom links now point at the two new
  examples (`redis_sql_search`, `redisvl_mcp_search`).
- `redis-agent-memory.md`: working-memory `model_name` bumped from
  `gemini-2.0-flash` to `gemini-2.5-flash`.
- `examples.md`: count bumped to nine; added `redis_sql_search` and
  `redisvl_mcp_search` entries.
- `semantic-caching.md`: vectorizer model bumped from
  `redis/langcache-embed-v1` to `redis/langcache-embed-v2` (matches
  the runnable examples and the rest of adk-redis docs). Agent model
  bumped from `gemini-2.0-flash` to `gemini-2.5-flash`.

What is intentionally NOT in this PR:

- No mention of `create_redisvl_mcp_toolset(...)`. That helper was in
  the adk-redis main branch briefly but was removed before 0.0.5
  shipped, per the catalog-page review feedback that pushed us toward
  using ADK's native `McpToolset` directly. The repo no longer ships
  it; the docs should not reference it.
- No mention of the `[mcp-search]` extra. Same reason.

Verified all five files pass a grep for stale references
(`create_redisvl_mcp_toolset`, `mcp-search`, `gemini-2.0-flash`,
`langcache-embed-v1`, "four search tools", "seven examples").
nkanu17 and others added 2 commits May 20, 2026 15:25
Primary docs link now points to redis-developer.github.io/adk-redis/.
The redis.io integration page is kept as a secondary reference.
@nkanu17 nkanu17 marked this pull request as ready for review May 20, 2026 19:29
@nkanu17
Copy link
Copy Markdown
Contributor Author

nkanu17 commented May 20, 2026

Just another note: we released a suite of new products just earlier this week, and this integration might evolve to capture those as well! Therefore, there might be another update/PR in the future! So assuming that's fine and I can create an update later on! Thank you for all your help!

Yes definitely! We welcome followup PRs to update or add functionality to this page as the integrations and product space evolve. And you have the option to split up functionality on separate pages if you need to keep things scoped to distinct or non-overlapping integrations/products/solutions. One example of that is the MLflow AI Gateway page and the separate MLflow Tracing page.

Sounds good! Thank you for the insight, I think I made changes to reflect the changes requested and also moved/separated a portion of it!

Copy link
Copy Markdown
Collaborator

@koverholt koverholt left a comment

Choose a reason for hiding this comment

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

Thanks for working through the edits, and for the contributions and ongoing collaboration! All updates LGTM, merging.

@koverholt koverholt merged commit 04cc351 into google:main May 20, 2026
11 checks passed
@nkanu17
Copy link
Copy Markdown
Contributor Author

nkanu17 commented May 20, 2026

Thanks for working through the edits, and for the contributions and ongoing collaboration! All updates LGTM, merging.

Likewise! Thank you for the collab as well!

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants