From cee06c2d740f5f4b45a2c9c7a195f5477353613e Mon Sep 17 00:00:00 2001 From: Nitin Kanukolanu Date: Mon, 3 Aug 2026 11:20:56 -0400 Subject: [PATCH] docs(examples): add managed quickstart and label backends per example The docs site examples page was missing `managed_memory_quickstart` entirely, so the one example that runs on the default backend was not discoverable from the published docs. It also gave no way to tell which backend each memory example targets, which matters because half of them only work self-hosted. - Add `managed_memory_quickstart` to the memory table. - Add a Backend column to the memory table and a Runner column to all three tables, mirroring what `examples/README.md` already tracks. Several examples run under `adk web .` rather than `python main.py`, which the page did not say. - Note that auto-summarization, extraction strategies, recency-boosted search, and MCP require the self-hosted backend. - Home page said nine runnable agents; there are ten. Also complete the MCP tool table in concepts/memory.md. Agent Memory Server exposes `get_working_memory`, `compact_long_term_memories`, and `get_current_datetime` in addition to the seven already listed (verified against `agent_memory_server/mcp.py`). Verified `mkdocs build --strict` produces the same 64 warnings as unmodified main, none referencing the edited files. All pre-existing griffe docstring warnings in `src/adk_redis/tools/memory/`. --- docs/concepts/memory.md | 3 +++ docs/examples/index.md | 35 ++++++++++++++++++++--------------- docs/index.md | 2 +- 3 files changed, 24 insertions(+), 16 deletions(-) diff --git a/docs/concepts/memory.md b/docs/concepts/memory.md index d22f66e..0dd1c75 100644 --- a/docs/concepts/memory.md +++ b/docs/concepts/memory.md @@ -88,6 +88,9 @@ agent = Agent( | `delete_long_term_memories` | Remove memories by ID | | `memory_prompt` | Enrich a prompt with relevant memories | | `set_working_memory` | Write to the current session's working memory | +| `get_working_memory` | Read the current session's working memory | +| `compact_long_term_memories` | Deduplicate and compact stored memories | +| `get_current_datetime` | Resolve the current time for relative date reasoning | ## Option 2: SDK-Based Tools diff --git a/docs/examples/index.md b/docs/examples/index.md index 91174dd..94dac6a 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -9,24 +9,29 @@ directory and explains what it demonstrates. ## Memory and Sessions -| Example | What it shows | -|---------|---------------| -| [**Simple Redis memory**](https://github.com/redis-developer/adk-redis/tree/main/examples/simple_redis_memory) | Minimal agent with `RedisSessionMemoryService` and `RedisLongTermMemoryService`. | -| [**Fitness coach (MCP)**](https://github.com/redis-developer/adk-redis/tree/main/examples/fitness_coach_mcp) | MCP-based memory with `McpToolset` and Agent Memory Server. | -| [**Travel agent (hybrid)**](https://github.com/redis-developer/adk-redis/tree/main/examples/travel_agent_memory_hybrid) | Framework-managed sessions + memory with vector search over travel docs. | -| [**Travel agent (tools)**](https://github.com/redis-developer/adk-redis/tree/main/examples/travel_agent_memory_tools) | Same travel agent using LLM-controlled memory tools instead of framework services. | +Each memory example targets a specific backend. The examples that exercise +auto-summarization, extraction strategies, recency-boosted search, or MCP +require the self-hosted `opensource-agent-memory` backend. + +| Example | Backend | Runner | What it shows | +|---------|---------|--------|---------------| +| [**Managed memory quickstart**](https://github.com/redis-developer/adk-redis/tree/main/examples/managed_memory_quickstart) | `redis-agent-memory` | `python main.py` | Smallest memory agent, on the managed backend. No Docker or Agent Memory Server. | +| [**Simple Redis memory**](https://github.com/redis-developer/adk-redis/tree/main/examples/simple_redis_memory) | `opensource-agent-memory` | `python main.py` | Minimal agent with `RedisSessionMemoryService` and `RedisLongTermMemoryService`, plus auto-summarization and extraction. | +| [**Fitness coach (MCP)**](https://github.com/redis-developer/adk-redis/tree/main/examples/fitness_coach_mcp) | `opensource-agent-memory` only | `adk web .` | MCP-based memory with `McpToolset` and Agent Memory Server. The managed backend has no MCP endpoint. | +| [**Travel agent (hybrid)**](https://github.com/redis-developer/adk-redis/tree/main/examples/travel_agent_memory_hybrid) | `opensource-agent-memory` | `python main.py` | Framework-managed sessions + memory with vector search over travel docs. | +| [**Travel agent (tools)**](https://github.com/redis-developer/adk-redis/tree/main/examples/travel_agent_memory_tools) | `opensource-agent-memory`, switchable | `adk web .` | Same travel agent using LLM-controlled memory tools instead of framework services. Set `REDIS_MEMORY_BACKEND` to switch backends. | ## Search -| Example | What it shows | -|---------|---------------| -| [**Redis search tools**](https://github.com/redis-developer/adk-redis/tree/main/examples/redis_search_tools) | Vector, text, and range search tools in one agent. | -| [**SQL search**](https://github.com/redis-developer/adk-redis/tree/main/examples/redis_sql_search) | `RedisSQLSearchTool` answering catalog questions via parameterized SQL. | -| [**RedisVL MCP search**](https://github.com/redis-developer/adk-redis/tree/main/examples/redisvl_mcp_search) | Same knowledge base served via `rvl mcp` over MCP. | +| Example | Runner | What it shows | +|---------|--------|---------------| +| [**Redis search tools**](https://github.com/redis-developer/adk-redis/tree/main/examples/redis_search_tools) | `adk web .` | Vector, text, and range search tools in one agent. | +| [**SQL search**](https://github.com/redis-developer/adk-redis/tree/main/examples/redis_sql_search) | `adk web .` | `RedisSQLSearchTool` answering catalog questions via parameterized SQL. | +| [**RedisVL MCP search**](https://github.com/redis-developer/adk-redis/tree/main/examples/redisvl_mcp_search) | `adk web .` | Same knowledge base served via `rvl mcp` over MCP. | ## Semantic Caching -| Example | What it shows | -|---------|---------------| -| [**Semantic cache (RedisVL)**](https://github.com/redis-developer/adk-redis/tree/main/examples/semantic_cache) | Self-hosted semantic cache with `RedisVLCacheProvider`. | -| [**LangCache cache**](https://github.com/redis-developer/adk-redis/tree/main/examples/langcache_cache) | Managed semantic cache with `LangCacheProvider`. | +| Example | Runner | What it shows | +|---------|--------|---------------| +| [**Semantic cache (RedisVL)**](https://github.com/redis-developer/adk-redis/tree/main/examples/semantic_cache) | `python main.py` | Self-hosted semantic cache with `RedisVLCacheProvider`. | +| [**LangCache cache**](https://github.com/redis-developer/adk-redis/tree/main/examples/langcache_cache) | `python main.py` | Managed semantic cache with `LangCacheProvider`. | diff --git a/docs/index.md b/docs/index.md index 4fa0af8..6250066 100644 --- a/docs/index.md +++ b/docs/index.md @@ -47,7 +47,7 @@ docker run -d --name redis -p 6379:6379 redis:8 --- - Nine runnable agents covering memory, search, and caching. + Ten runnable agents covering memory, search, and caching. - :material-api:{ .lg .middle } **[API Reference](api/index.md)**