Clarify MemoryClient deprecation status - documentation inconsistency

Open
#242 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by comparing the three MemoryClient references in src/bedrock_agentcore/memory/README.md with MemoryClient.init() in src/bedrock_agentcore/memory/client.py. Review the three proposed options and confirm the intended deprecation policy with a maintainer before editing. Done means the documentation and any approved warning behavior consistently describe MemoryClient’s status.

Written by the indexing model from the issue text.

Description

Summary

The documentation for MemoryClient has inconsistent messaging about its status:

  1. src/bedrock_agentcore/memory/README.md#L39: "MemoryClient - Legacy client interface (still supported but not recommended for new projects)"
  2. src/bedrock_agentcore/memory/README.md#L120: "While still supported, we recommend migrating to MemorySessionManager for new projects"
  3. src/bedrock_agentcore/memory/README.md#L555: "MemoryClient: Legacy client interface (deprecated)"

The first two say "still supported" while the third says "deprecated". Additionally, there's no actual DeprecationWarning in the code when users instantiate MemoryClient.

Proposed Options

Option A: Formally deprecate MemoryClient
  • Add DeprecationWarning to MemoryClient.__init__()
  • Update all documentation to consistently say "deprecated"
  • Set a target removal version (e.g., v2.0.0)
Option B: Keep as "legacy" without formal deprecation
  • Remove "deprecated" from API Reference section
  • Keep "legacy" and "not recommended" language
  • No code changes needed
Option C: Staged approach
  • Fix documentation to be consistent ("legacy, not recommended")
  • Add deprecation warning in a future minor release
  • Remove in a future major release
Dominant language
Python
Stars
786
Forks
163
Avg merge
4h
Merged PRs (30d)
22

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aws/bedrock-agentcore-sdk-python

All issues in aws/bedrock-agentcore-sdk-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.