docs: Add OpenMemory product as ADK MemoryService option #859
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive documentation for OpenMemory, a self-hosted, open-source memory system for AI agents that was recently added to ADK. The PR includes:
docs/sessions/memory.md, including installation, configuration, setup instructions, and usage examples--memory_service_uriflagThis documentation makes OpenMemory fully accessible to users, providing clear guidance on installation, setup, configuration, and usage patterns.
Related PRs
Link to Issue or Description of Change
2. No existing issue - documentation for existing OpenMemory feature
Problem:
Following the OpenMemory implementation in
adk-python, users needed:Solution:
This PR provides:
docs/sessions/memory.mdfollowing the same pattern as Vertex AI Memory Bankadk-pythonChanges
Documentation Updates (
docs/sessions/memory.md)Updated comparison table: Added
OpenMemoryServiceas a third column with feature comparisonsNew OpenMemory section (after Vertex AI Memory Bank):
pip install google-adk[openmemory]adk webandadk api_serverwith URI formatsOpenMemoryServiceConfigparameters documentationUpdated multi-memory service section: Added OpenMemoryService to examples and updated code samples
Technical Decisions
Documentation Structure
The documentation follows the exact same structure as Vertex AI Memory Bank, ensuring consistency and making it easy for users to compare options. The side-by-side comparison table helps users quickly identify which memory service fits their needs.
CLI Examples Alignment
All CLI examples in the documentation match the URI format implementation in
adk-python:openmemory://localhost:3000formatThe examples are tested against the actual CLI implementation to ensure accuracy.
Testing Plan
Documentation Validation
adk-pythonManual Review
Checklist
Additional Context
Documentation Structure
The documentation is organized to match Vertex AI Memory Bank:
Markdown Quality
Related Implementation
This documentation covers the OpenMemory feature implemented in
adk-python(google/adk-python#3386), including:openmemory://scheme