docs: document selectable memory backends and managed setup#18
Conversation
- Reconcile env var names to canonical REDIS_AGENT_MEMORY_* (with AGENT_MEMORY_* fallbacks) in 01_integration.md - Add managed Redis Agent Memory setup how-to and wire into nav/index - Fix stale 'Agent Memory Server only' framing in concepts/memory.md - Advertise public backend constants in llms.txt and config snippets - README: add managed_memory_quickstart to examples matrix and fix the 'all examples run via adk web' claim
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 38957d3768
ℹ️ 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".
| from google.adk.tools import load_memory | ||
| from google.adk.tools import preload_memory | ||
| from adk_redis import ( | ||
| REDIS_AGENT_MEMORY_BACKEND, |
There was a problem hiding this comment.
These snippets now tell users to from adk_redis import REDIS_AGENT_MEMORY_BACKEND, but this commit only changes docs and the public package initializer does not import or export REDIS_AGENT_MEMORY_BACKEND, OPENSOURCE_AGENT_MEMORY_BACKEND, or MemoryBackendName. When a release is built from this commit without the dependent export change, following the quickstart or managed setup guide raises ImportError before any service is constructed; either add the constants to adk_redis.__init__ in the same change or keep using the string literal until the export lands.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Pull request overview
Updates the documentation to reflect the dual, selectable Redis Agent Memory backends (managed redis-agent-memory vs self-hosted opensource-agent-memory), and adds a new managed-backend setup guide wired into the MkDocs navigation.
Changes:
- Adds a new managed Redis Agent Memory setup how-to and links it from the how-to index and
mkdocs.ymlnav. - Updates the quickstart integration guide to use the
REDIS_AGENT_MEMORY_*environment variable names and documents the backend selector constants. - Refreshes conceptual docs (including the memory diagram) and top-level indices (README,
docs/llms.txt) to reflect both backends.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates examples matrix and clarifies which examples run via python main.py vs adk web. |
| mkdocs.yml | Adds the new managed setup page to the navigation. |
| docs/user_guide/how_to_guides/managed_memory_setup.md | New step-by-step guide for configuring the managed redis-agent-memory backend. |
| docs/user_guide/how_to_guides/index.md | Links the new managed memory setup guide from the how-to index. |
| docs/user_guide/01_integration.md | Reconciles env var names and updates the quickstart wiring snippet for selectable backends. |
| docs/llms.txt | Adds the managed setup link and recommends importing backend constants/types for typo safety. |
| docs/concepts/memory.md | Updates quick reference, diagram labeling, and tool config snippet to reflect selectable backends. |
Comments suppressed due to low confidence (1)
docs/concepts/memory.md:33
- The diagram now implies the MCP path can target either Redis Agent Memory or Agent Memory Server. That contradicts the note immediately below (and the actual backend capabilities): MCP is only available on the self-hosted Agent Memory Server.
MCPS --> AMS["Redis Agent Memory<br/>or Agent Memory Server"]
REST --> AMS
AMS --> WM[Working Memory]
AMS --> LTM[Long-Term Memory]
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| These are the same variable names used by the | ||
| [managed memory quickstart](how_to_guides/managed_memory_setup.md) and the | ||
| integration tests. For the open source self-hosted Agent Memory Server, use | ||
| `REDIS_MEMORY_BACKEND="opensource-agent-memory"`, point | ||
| `REDIS_AGENT_MEMORY_API_BASE_URL` at your server, and omit the API key and | ||
| store ID unless your deployment requires them. |
| session_service = RedisWorkingMemorySessionService( | ||
| config=RedisWorkingMemorySessionServiceConfig( | ||
| backend=os.getenv("REDIS_MEMORY_BACKEND", "redis-agent-memory"), | ||
| api_base_url=os.environ["AGENT_MEMORY_SERVER_URL"], | ||
| api_key=os.environ.get("AGENT_MEMORY_API_KEY"), | ||
| store_id=os.environ.get("AGENT_MEMORY_STORE_ID"), | ||
| backend=backend, | ||
| api_base_url=os.environ["REDIS_AGENT_MEMORY_API_BASE_URL"], | ||
| api_key=os.environ.get("REDIS_AGENT_MEMORY_API_KEY"), | ||
| store_id=os.environ.get("REDIS_AGENT_MEMORY_STORE_ID"), |
| # REDIS_AGENT_MEMORY_BACKEND and OPENSOURCE_AGENT_MEMORY_BACKEND are typo-safe | ||
| # aliases for the "redis-agent-memory" and "opensource-agent-memory" strings. |
| - ADK session IDs that exceed the limit or contain unsupported characters are | ||
| hashed to a stable hex value that fits the 64-character cap. |
Summary
Documentation updates reflecting the selectable memory backends (managed
redis-agent-memoryvs. self-hostedopensource-agent-memory) from #16.Changes
docs/user_guide/01_integration.md): use canonicalREDIS_AGENT_MEMORY_*names (withAGENT_MEMORY_*fallbacks), matching the examples and integration tests.docs/user_guide/how_to_guides/managed_memory_setup.md, new): step-by-step setup for the managed backend; wired into nav (mkdocs.yml) and the how-to index.docs/concepts/memory.md): Quick Reference and architecture diagram now reflect both backends instead of "Agent Memory Server only".docs/llms.txt, config snippets): documentREDIS_AGENT_MEMORY_BACKEND/OPENSOURCE_AGENT_MEMORY_BACKEND/MemoryBackendName. String literals remain equally valid.managed_memory_quickstartto the examples matrix; correct the "all examples run viaadk web" claim (some run viapython main.pythroughget_service_registry()).Validation
mkdocs build --strictpasses (no nav/link warnings for the new page).