Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions docs/memory.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,115 @@ agentcore add memory \
--owner MyAgent
```

## Swapping or Changing Memory (Strands)

For Strands agents, when you create an agent with memory, the CLI generates a `memory/session.py` file that references a
specific memory via environment variable. To swap which memory your agent uses:

### Step 1: Check Available Memories

Look at your `agentcore/agentcore.json` to see defined memories:

```json
{
"memories": [
{ "name": "MyAgentMemory", ... },
{ "name": "SharedMemory", ... },
{ "name": "UserPrefMemory", ... }
]
}
```

Each memory gets an environment variable: `MEMORY_<NAME>_ID` (uppercase, underscores).

### Step 2: Update session.py

Edit `app/<YourAgent>/memory/session.py` and change the `MEMORY_ID` line:

```python
# Before: using MyAgentMemory
MEMORY_ID = os.getenv("MEMORY_MYAGENTMEMORY_ID")

# After: switch to SharedMemory
MEMORY_ID = os.getenv("MEMORY_SHAREDMEMORY_ID")
```

### Step 3: Redeploy

```bash
agentcore deploy
```

### Adding Memory to an Agent Without Memory (Strands)

If you created an agent without memory and want to add it later:

1. Add a memory to your project:

```bash
agentcore add memory --name MyMemory --strategies SEMANTIC
```

2. Create the `memory/` directory in your agent:

```bash
mkdir -p app/MyAgent/memory
```

3. Create `app/MyAgent/memory/session.py`:

```python
import os
from typing import Optional
from bedrock_agentcore.memory.integrations.strands.config import AgentCoreMemoryConfig, RetrievalConfig
from bedrock_agentcore.memory.integrations.strands.session_manager import AgentCoreMemorySessionManager

MEMORY_ID = os.getenv("MEMORY_MYMEMORY_ID")
REGION = os.getenv("AWS_REGION")

def get_memory_session_manager(session_id: str, actor_id: str) -> Optional[AgentCoreMemorySessionManager]:
if not MEMORY_ID:
return None

retrieval_config = {
f"/users/{actor_id}/facts": RetrievalConfig(top_k=3, relevance_score=0.5),
f"/users/{actor_id}/preferences": RetrievalConfig(top_k=3, relevance_score=0.5),
}

return AgentCoreMemorySessionManager(
AgentCoreMemoryConfig(
memory_id=MEMORY_ID,
session_id=session_id,
actor_id=actor_id,
retrieval_config=retrieval_config,
),
REGION
)
```

4. Update `main.py` to use the session manager:

```python
from memory.session import get_memory_session_manager

@app.entrypoint
async def invoke(payload, context):
session_id = getattr(context, 'session_id', 'default-session')
user_id = getattr(context, 'user_id', 'default-user')
session_manager = get_memory_session_manager(session_id, user_id)

agent = Agent(
model=load_model(),
session_manager=session_manager, # Add this line
...
)
```

5. Deploy:
```bash
agentcore deploy
```

## Memory Strategies

| Strategy | Description |
Expand Down
41 changes: 39 additions & 2 deletions src/cli/tui/screens/add/AddFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { AddSuccessScreen } from './AddSuccessScreen';
import { AddTargetScreen } from './AddTargetScreen';
import { useAddTarget, useExistingTargets } from './useAddTarget';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -254,13 +255,29 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-create-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Created agent: ${flow.agentName}`}
summary={
!flow.loading && (
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
Expand All@@ -278,11 +295,31 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-byo-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Added agent: ${flow.agentName}`}
summary={!flow.loading && <AgentAddedSummary config={flow.config} projectName={flow.projectName} />}
summary={
!flow.loading && (
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
loading={flow.loading}
loadingMessage={flow.loadingMessage}
Expand Down
20 changes: 15 additions & 5 deletions src/cli/tui/screens/memory/AddMemoryFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@ import { useCreateMemory, useExistingMemoryNames } from '../../hooks/useCreateMe
import { AddSuccessScreen } from '../add/AddSuccessScreen';
import { AddMemoryScreen } from './AddMemoryScreen';
import type { AddMemoryConfig } from './types';
import { Text } from 'ink';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -60,10 +61,19 @@ export function AddMemoryFlow({ isInteractive = true, onExit, onBack, onDev, onD
message={`Added memory: ${flow.memoryName}`}
detail="Memory added to project in `agentcore/agentcore.json`."
summary={
<Text color="yellow">
Note: Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
<Box flexDirection="column">
<Text color="yellow">
Note: See{' '}
<Link url="https://github.com/aws/agentcore-cli/blob/main/docs/memory.md#swapping-or-changing-memory-strands">
<Text color="cyan">docs/memory.md</Text>
</Link>{' '}
to learn how to connect memory to your agent.
</Text>
<Text color="yellow">
Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
</Box>
}
onAddAnother={onBack}
onDev={onDev}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
chore: add memory documentation hints to CLI output by aidandaly24 · Pull Request #227 · aws/agentcore-cli · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions docs/memory.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,115 @@ agentcore add memory \
--owner MyAgent
```

## Swapping or Changing Memory (Strands)

For Strands agents, when you create an agent with memory, the CLI generates a `memory/session.py` file that references a
specific memory via environment variable. To swap which memory your agent uses:

### Step 1: Check Available Memories

Look at your `agentcore/agentcore.json` to see defined memories:

```json
{
"memories": [
{ "name": "MyAgentMemory", ... },
{ "name": "SharedMemory", ... },
{ "name": "UserPrefMemory", ... }
]
}
```

Each memory gets an environment variable: `MEMORY_<NAME>_ID` (uppercase, underscores).

### Step 2: Update session.py

Edit `app/<YourAgent>/memory/session.py` and change the `MEMORY_ID` line:

```python
# Before: using MyAgentMemory
MEMORY_ID = os.getenv("MEMORY_MYAGENTMEMORY_ID")

# After: switch to SharedMemory
MEMORY_ID = os.getenv("MEMORY_SHAREDMEMORY_ID")
```

### Step 3: Redeploy

```bash
agentcore deploy
```

### Adding Memory to an Agent Without Memory (Strands)

If you created an agent without memory and want to add it later:

1. Add a memory to your project:

```bash
agentcore add memory --name MyMemory --strategies SEMANTIC
```

2. Create the `memory/` directory in your agent:

```bash
mkdir -p app/MyAgent/memory
```

3. Create `app/MyAgent/memory/session.py`:

```python
import os
from typing import Optional
from bedrock_agentcore.memory.integrations.strands.config import AgentCoreMemoryConfig, RetrievalConfig
from bedrock_agentcore.memory.integrations.strands.session_manager import AgentCoreMemorySessionManager

MEMORY_ID = os.getenv("MEMORY_MYMEMORY_ID")
REGION = os.getenv("AWS_REGION")

def get_memory_session_manager(session_id: str, actor_id: str) -> Optional[AgentCoreMemorySessionManager]:
if not MEMORY_ID:
return None

retrieval_config = {
f"/users/{actor_id}/facts": RetrievalConfig(top_k=3, relevance_score=0.5),
f"/users/{actor_id}/preferences": RetrievalConfig(top_k=3, relevance_score=0.5),
}

return AgentCoreMemorySessionManager(
AgentCoreMemoryConfig(
memory_id=MEMORY_ID,
session_id=session_id,
actor_id=actor_id,
retrieval_config=retrieval_config,
),
REGION
)
```

4. Update `main.py` to use the session manager:

```python
from memory.session import get_memory_session_manager

@app.entrypoint
async def invoke(payload, context):
session_id = getattr(context, 'session_id', 'default-session')
user_id = getattr(context, 'user_id', 'default-user')
session_manager = get_memory_session_manager(session_id, user_id)

agent = Agent(
model=load_model(),
session_manager=session_manager, # Add this line
...
)
```

5. Deploy:
```bash
agentcore deploy
```

## Memory Strategies

| Strategy | Description |
Expand Down
41 changes: 39 additions & 2 deletions src/cli/tui/screens/add/AddFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { AddSuccessScreen } from './AddSuccessScreen';
import { AddTargetScreen } from './AddTargetScreen';
import { useAddTarget, useExistingTargets } from './useAddTarget';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -254,13 +255,29 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-create-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Created agent: ${flow.agentName}`}
summary={
!flow.loading && (
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
Expand All@@ -278,11 +295,31 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-byo-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Added agent: ${flow.agentName}`}
summary={!flow.loading && <AgentAddedSummary config={flow.config} projectName={flow.projectName} />}
summary={
!flow.loading && (
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
loading={flow.loading}
loadingMessage={flow.loadingMessage}
Expand Down
20 changes: 15 additions & 5 deletions src/cli/tui/screens/memory/AddMemoryFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@ import { useCreateMemory, useExistingMemoryNames } from '../../hooks/useCreateMe
import { AddSuccessScreen } from '../add/AddSuccessScreen';
import { AddMemoryScreen } from './AddMemoryScreen';
import type { AddMemoryConfig } from './types';
import { Text } from 'ink';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -60,10 +61,19 @@ export function AddMemoryFlow({ isInteractive = true, onExit, onBack, onDev, onD
message={`Added memory: ${flow.memoryName}`}
detail="Memory added to project in `agentcore/agentcore.json`."
summary={
<Text color="yellow">
Note: Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
<Box flexDirection="column">
<Text color="yellow">
Note: See{' '}
<Link url="https://github.com/aws/agentcore-cli/blob/main/docs/memory.md#swapping-or-changing-memory-strands">
<Text color="cyan">docs/memory.md</Text>
</Link>{' '}
to learn how to connect memory to your agent.
</Text>
<Text color="yellow">
Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
</Box>
}
onAddAnother={onBack}
onDev={onDev}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' chore: add memory documentation hints to CLI output by aidandaly24 · Pull Request #227 · aws/agentcore-cli · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions docs/memory.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,115 @@ agentcore add memory \
--owner MyAgent
```

## Swapping or Changing Memory (Strands)

For Strands agents, when you create an agent with memory, the CLI generates a `memory/session.py` file that references a
specific memory via environment variable. To swap which memory your agent uses:

### Step 1: Check Available Memories

Look at your `agentcore/agentcore.json` to see defined memories:

```json
{
"memories": [
{ "name": "MyAgentMemory", ... },
{ "name": "SharedMemory", ... },
{ "name": "UserPrefMemory", ... }
]
}
```

Each memory gets an environment variable: `MEMORY_<NAME>_ID` (uppercase, underscores).

### Step 2: Update session.py

Edit `app/<YourAgent>/memory/session.py` and change the `MEMORY_ID` line:

```python
# Before: using MyAgentMemory
MEMORY_ID = os.getenv("MEMORY_MYAGENTMEMORY_ID")

# After: switch to SharedMemory
MEMORY_ID = os.getenv("MEMORY_SHAREDMEMORY_ID")
```

### Step 3: Redeploy

```bash
agentcore deploy
```

### Adding Memory to an Agent Without Memory (Strands)

If you created an agent without memory and want to add it later:

1. Add a memory to your project:

```bash
agentcore add memory --name MyMemory --strategies SEMANTIC
```

2. Create the `memory/` directory in your agent:

```bash
mkdir -p app/MyAgent/memory
```

3. Create `app/MyAgent/memory/session.py`:

```python
import os
from typing import Optional
from bedrock_agentcore.memory.integrations.strands.config import AgentCoreMemoryConfig, RetrievalConfig
from bedrock_agentcore.memory.integrations.strands.session_manager import AgentCoreMemorySessionManager

MEMORY_ID = os.getenv("MEMORY_MYMEMORY_ID")
REGION = os.getenv("AWS_REGION")

def get_memory_session_manager(session_id: str, actor_id: str) -> Optional[AgentCoreMemorySessionManager]:
if not MEMORY_ID:
return None

retrieval_config = {
f"/users/{actor_id}/facts": RetrievalConfig(top_k=3, relevance_score=0.5),
f"/users/{actor_id}/preferences": RetrievalConfig(top_k=3, relevance_score=0.5),
}

return AgentCoreMemorySessionManager(
AgentCoreMemoryConfig(
memory_id=MEMORY_ID,
session_id=session_id,
actor_id=actor_id,
retrieval_config=retrieval_config,
),
REGION
)
```

4. Update `main.py` to use the session manager:

```python
from memory.session import get_memory_session_manager

@app.entrypoint
async def invoke(payload, context):
session_id = getattr(context, 'session_id', 'default-session')
user_id = getattr(context, 'user_id', 'default-user')
session_manager = get_memory_session_manager(session_id, user_id)

agent = Agent(
model=load_model(),
session_manager=session_manager, # Add this line
...
)
```

5. Deploy:
```bash
agentcore deploy
```

## Memory Strategies

| Strategy | Description |
Expand Down
41 changes: 39 additions & 2 deletions src/cli/tui/screens/add/AddFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { AddSuccessScreen } from './AddSuccessScreen';
import { AddTargetScreen } from './AddTargetScreen';
import { useAddTarget, useExistingTargets } from './useAddTarget';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -254,13 +255,29 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-create-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Created agent: ${flow.agentName}`}
summary={
!flow.loading && (
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
Expand All@@ -278,11 +295,31 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-byo-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Added agent: ${flow.agentName}`}
summary={!flow.loading && <AgentAddedSummary config={flow.config} projectName={flow.projectName} />}
summary={
!flow.loading && (
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
loading={flow.loading}
loadingMessage={flow.loadingMessage}
Expand Down
20 changes: 15 additions & 5 deletions src/cli/tui/screens/memory/AddMemoryFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@ import { useCreateMemory, useExistingMemoryNames } from '../../hooks/useCreateMe
import { AddSuccessScreen } from '../add/AddSuccessScreen';
import { AddMemoryScreen } from './AddMemoryScreen';
import type { AddMemoryConfig } from './types';
import { Text } from 'ink';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -60,10 +61,19 @@ export function AddMemoryFlow({ isInteractive = true, onExit, onBack, onDev, onD
message={`Added memory: ${flow.memoryName}`}
detail="Memory added to project in `agentcore/agentcore.json`."
summary={
<Text color="yellow">
Note: Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
<Box flexDirection="column">
<Text color="yellow">
Note: See{' '}
<Link url="https://github.com/aws/agentcore-cli/blob/main/docs/memory.md#swapping-or-changing-memory-strands">
<Text color="cyan">docs/memory.md</Text>
</Link>{' '}
to learn how to connect memory to your agent.
</Text>
<Text color="yellow">
Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
</Box>
}
onAddAnother={onBack}
onDev={onDev}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' chore: add memory documentation hints to CLI output by aidandaly24 · Pull Request #227 · aws/agentcore-cli · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions docs/memory.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,115 @@ agentcore add memory \
--owner MyAgent
```

## Swapping or Changing Memory (Strands)

For Strands agents, when you create an agent with memory, the CLI generates a `memory/session.py` file that references a
specific memory via environment variable. To swap which memory your agent uses:

### Step 1: Check Available Memories

Look at your `agentcore/agentcore.json` to see defined memories:

```json
{
"memories": [
{ "name": "MyAgentMemory", ... },
{ "name": "SharedMemory", ... },
{ "name": "UserPrefMemory", ... }
]
}
```

Each memory gets an environment variable: `MEMORY_<NAME>_ID` (uppercase, underscores).

### Step 2: Update session.py

Edit `app/<YourAgent>/memory/session.py` and change the `MEMORY_ID` line:

```python
# Before: using MyAgentMemory
MEMORY_ID = os.getenv("MEMORY_MYAGENTMEMORY_ID")

# After: switch to SharedMemory
MEMORY_ID = os.getenv("MEMORY_SHAREDMEMORY_ID")
```

### Step 3: Redeploy

```bash
agentcore deploy
```

### Adding Memory to an Agent Without Memory (Strands)

If you created an agent without memory and want to add it later:

1. Add a memory to your project:

```bash
agentcore add memory --name MyMemory --strategies SEMANTIC
```

2. Create the `memory/` directory in your agent:

```bash
mkdir -p app/MyAgent/memory
```

3. Create `app/MyAgent/memory/session.py`:

```python
import os
from typing import Optional
from bedrock_agentcore.memory.integrations.strands.config import AgentCoreMemoryConfig, RetrievalConfig
from bedrock_agentcore.memory.integrations.strands.session_manager import AgentCoreMemorySessionManager

MEMORY_ID = os.getenv("MEMORY_MYMEMORY_ID")
REGION = os.getenv("AWS_REGION")

def get_memory_session_manager(session_id: str, actor_id: str) -> Optional[AgentCoreMemorySessionManager]:
if not MEMORY_ID:
return None

retrieval_config = {
f"/users/{actor_id}/facts": RetrievalConfig(top_k=3, relevance_score=0.5),
f"/users/{actor_id}/preferences": RetrievalConfig(top_k=3, relevance_score=0.5),
}

return AgentCoreMemorySessionManager(
AgentCoreMemoryConfig(
memory_id=MEMORY_ID,
session_id=session_id,
actor_id=actor_id,
retrieval_config=retrieval_config,
),
REGION
)
```

4. Update `main.py` to use the session manager:

```python
from memory.session import get_memory_session_manager

@app.entrypoint
async def invoke(payload, context):
session_id = getattr(context, 'session_id', 'default-session')
user_id = getattr(context, 'user_id', 'default-user')
session_manager = get_memory_session_manager(session_id, user_id)

agent = Agent(
model=load_model(),
session_manager=session_manager, # Add this line
...
)
```

5. Deploy:
```bash
agentcore deploy
```

## Memory Strategies

| Strategy | Description |
Expand Down
41 changes: 39 additions & 2 deletions src/cli/tui/screens/add/AddFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { AddSuccessScreen } from './AddSuccessScreen';
import { AddTargetScreen } from './AddTargetScreen';
import { useAddTarget, useExistingTargets } from './useAddTarget';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -254,13 +255,29 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-create-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Created agent: ${flow.agentName}`}
summary={
!flow.loading && (
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
Expand All@@ -278,11 +295,31 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-byo-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Added agent: ${flow.agentName}`}
summary={!flow.loading && <AgentAddedSummary config={flow.config} projectName={flow.projectName} />}
summary={
!flow.loading && (
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
loading={flow.loading}
loadingMessage={flow.loadingMessage}
Expand Down
20 changes: 15 additions & 5 deletions src/cli/tui/screens/memory/AddMemoryFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@ import { useCreateMemory, useExistingMemoryNames } from '../../hooks/useCreateMe
import { AddSuccessScreen } from '../add/AddSuccessScreen';
import { AddMemoryScreen } from './AddMemoryScreen';
import type { AddMemoryConfig } from './types';
import { Text } from 'ink';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -60,10 +61,19 @@ export function AddMemoryFlow({ isInteractive = true, onExit, onBack, onDev, onD
message={`Added memory: ${flow.memoryName}`}
detail="Memory added to project in `agentcore/agentcore.json`."
summary={
<Text color="yellow">
Note: Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
<Box flexDirection="column">
<Text color="yellow">
Note: See{' '}
<Link url="https://github.com/aws/agentcore-cli/blob/main/docs/memory.md#swapping-or-changing-memory-strands">
<Text color="cyan">docs/memory.md</Text>
</Link>{' '}
to learn how to connect memory to your agent.
</Text>
<Text color="yellow">
Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
</Box>
}
onAddAnother={onBack}
onDev={onDev}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' chore: add memory documentation hints to CLI output by aidandaly24 · Pull Request #227 · aws/agentcore-cli · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions docs/memory.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,115 @@ agentcore add memory \
--owner MyAgent
```

## Swapping or Changing Memory (Strands)

For Strands agents, when you create an agent with memory, the CLI generates a `memory/session.py` file that references a
specific memory via environment variable. To swap which memory your agent uses:

### Step 1: Check Available Memories

Look at your `agentcore/agentcore.json` to see defined memories:

```json
{
"memories": [
{ "name": "MyAgentMemory", ... },
{ "name": "SharedMemory", ... },
{ "name": "UserPrefMemory", ... }
]
}
```

Each memory gets an environment variable: `MEMORY_<NAME>_ID` (uppercase, underscores).

### Step 2: Update session.py

Edit `app/<YourAgent>/memory/session.py` and change the `MEMORY_ID` line:

```python
# Before: using MyAgentMemory
MEMORY_ID = os.getenv("MEMORY_MYAGENTMEMORY_ID")

# After: switch to SharedMemory
MEMORY_ID = os.getenv("MEMORY_SHAREDMEMORY_ID")
```

### Step 3: Redeploy

```bash
agentcore deploy
```

### Adding Memory to an Agent Without Memory (Strands)

If you created an agent without memory and want to add it later:

1. Add a memory to your project:

```bash
agentcore add memory --name MyMemory --strategies SEMANTIC
```

2. Create the `memory/` directory in your agent:

```bash
mkdir -p app/MyAgent/memory
```

3. Create `app/MyAgent/memory/session.py`:

```python
import os
from typing import Optional
from bedrock_agentcore.memory.integrations.strands.config import AgentCoreMemoryConfig, RetrievalConfig
from bedrock_agentcore.memory.integrations.strands.session_manager import AgentCoreMemorySessionManager

MEMORY_ID = os.getenv("MEMORY_MYMEMORY_ID")
REGION = os.getenv("AWS_REGION")

def get_memory_session_manager(session_id: str, actor_id: str) -> Optional[AgentCoreMemorySessionManager]:
if not MEMORY_ID:
return None

retrieval_config = {
f"/users/{actor_id}/facts": RetrievalConfig(top_k=3, relevance_score=0.5),
f"/users/{actor_id}/preferences": RetrievalConfig(top_k=3, relevance_score=0.5),
}

return AgentCoreMemorySessionManager(
AgentCoreMemoryConfig(
memory_id=MEMORY_ID,
session_id=session_id,
actor_id=actor_id,
retrieval_config=retrieval_config,
),
REGION
)
```

4. Update `main.py` to use the session manager:

```python
from memory.session import get_memory_session_manager

@app.entrypoint
async def invoke(payload, context):
session_id = getattr(context, 'session_id', 'default-session')
user_id = getattr(context, 'user_id', 'default-user')
session_manager = get_memory_session_manager(session_id, user_id)

agent = Agent(
model=load_model(),
session_manager=session_manager, # Add this line
...
)
```

5. Deploy:
```bash
agentcore deploy
```

## Memory Strategies

| Strategy | Description |
Expand Down
41 changes: 39 additions & 2 deletions src/cli/tui/screens/add/AddFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { AddSuccessScreen } from './AddSuccessScreen';
import { AddTargetScreen } from './AddTargetScreen';
import { useAddTarget, useExistingTargets } from './useAddTarget';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -254,13 +255,29 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-create-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Created agent: ${flow.agentName}`}
summary={
!flow.loading && (
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
Expand All@@ -278,11 +295,31 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-byo-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Added agent: ${flow.agentName}`}
summary={!flow.loading && <AgentAddedSummary config={flow.config} projectName={flow.projectName} />}
summary={
!flow.loading && (
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
loading={flow.loading}
loadingMessage={flow.loadingMessage}
Expand Down
20 changes: 15 additions & 5 deletions src/cli/tui/screens/memory/AddMemoryFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@ import { useCreateMemory, useExistingMemoryNames } from '../../hooks/useCreateMe
import { AddSuccessScreen } from '../add/AddSuccessScreen';
import { AddMemoryScreen } from './AddMemoryScreen';
import type { AddMemoryConfig } from './types';
import { Text } from 'ink';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -60,10 +61,19 @@ export function AddMemoryFlow({ isInteractive = true, onExit, onBack, onDev, onD
message={`Added memory: ${flow.memoryName}`}
detail="Memory added to project in `agentcore/agentcore.json`."
summary={
<Text color="yellow">
Note: Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
<Box flexDirection="column">
<Text color="yellow">
Note: See{' '}
<Link url="https://github.com/aws/agentcore-cli/blob/main/docs/memory.md#swapping-or-changing-memory-strands">
<Text color="cyan">docs/memory.md</Text>
</Link>{' '}
to learn how to connect memory to your agent.
</Text>
<Text color="yellow">
Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
</Box>
}
onAddAnother={onBack}
onDev={onDev}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' chore: add memory documentation hints to CLI output by aidandaly24 · Pull Request #227 · aws/agentcore-cli · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions docs/memory.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,115 @@ agentcore add memory \
--owner MyAgent
```

## Swapping or Changing Memory (Strands)

For Strands agents, when you create an agent with memory, the CLI generates a `memory/session.py` file that references a
specific memory via environment variable. To swap which memory your agent uses:

### Step 1: Check Available Memories

Look at your `agentcore/agentcore.json` to see defined memories:

```json
{
"memories": [
{ "name": "MyAgentMemory", ... },
{ "name": "SharedMemory", ... },
{ "name": "UserPrefMemory", ... }
]
}
```

Each memory gets an environment variable: `MEMORY_<NAME>_ID` (uppercase, underscores).

### Step 2: Update session.py

Edit `app/<YourAgent>/memory/session.py` and change the `MEMORY_ID` line:

```python
# Before: using MyAgentMemory
MEMORY_ID = os.getenv("MEMORY_MYAGENTMEMORY_ID")

# After: switch to SharedMemory
MEMORY_ID = os.getenv("MEMORY_SHAREDMEMORY_ID")
```

### Step 3: Redeploy

```bash
agentcore deploy
```

### Adding Memory to an Agent Without Memory (Strands)

If you created an agent without memory and want to add it later:

1. Add a memory to your project:

```bash
agentcore add memory --name MyMemory --strategies SEMANTIC
```

2. Create the `memory/` directory in your agent:

```bash
mkdir -p app/MyAgent/memory
```

3. Create `app/MyAgent/memory/session.py`:

```python
import os
from typing import Optional
from bedrock_agentcore.memory.integrations.strands.config import AgentCoreMemoryConfig, RetrievalConfig
from bedrock_agentcore.memory.integrations.strands.session_manager import AgentCoreMemorySessionManager

MEMORY_ID = os.getenv("MEMORY_MYMEMORY_ID")
REGION = os.getenv("AWS_REGION")

def get_memory_session_manager(session_id: str, actor_id: str) -> Optional[AgentCoreMemorySessionManager]:
if not MEMORY_ID:
return None

retrieval_config = {
f"/users/{actor_id}/facts": RetrievalConfig(top_k=3, relevance_score=0.5),
f"/users/{actor_id}/preferences": RetrievalConfig(top_k=3, relevance_score=0.5),
}

return AgentCoreMemorySessionManager(
AgentCoreMemoryConfig(
memory_id=MEMORY_ID,
session_id=session_id,
actor_id=actor_id,
retrieval_config=retrieval_config,
),
REGION
)
```

4. Update `main.py` to use the session manager:

```python
from memory.session import get_memory_session_manager

@app.entrypoint
async def invoke(payload, context):
session_id = getattr(context, 'session_id', 'default-session')
user_id = getattr(context, 'user_id', 'default-user')
session_manager = get_memory_session_manager(session_id, user_id)

agent = Agent(
model=load_model(),
session_manager=session_manager, # Add this line
...
)
```

5. Deploy:
```bash
agentcore deploy
```

## Memory Strategies

| Strategy | Description |
Expand Down
41 changes: 39 additions & 2 deletions src/cli/tui/screens/add/AddFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { AddSuccessScreen } from './AddSuccessScreen';
import { AddTargetScreen } from './AddTargetScreen';
import { useAddTarget, useExistingTargets } from './useAddTarget';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -254,13 +255,29 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-create-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Created agent: ${flow.agentName}`}
summary={
!flow.loading && (
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
Expand All@@ -278,11 +295,31 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-byo-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Added agent: ${flow.agentName}`}
summary={!flow.loading && <AgentAddedSummary config={flow.config} projectName={flow.projectName} />}
summary={
!flow.loading && (
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
loading={flow.loading}
loadingMessage={flow.loadingMessage}
Expand Down
20 changes: 15 additions & 5 deletions src/cli/tui/screens/memory/AddMemoryFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@ import { useCreateMemory, useExistingMemoryNames } from '../../hooks/useCreateMe
import { AddSuccessScreen } from '../add/AddSuccessScreen';
import { AddMemoryScreen } from './AddMemoryScreen';
import type { AddMemoryConfig } from './types';
import { Text } from 'ink';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -60,10 +61,19 @@ export function AddMemoryFlow({ isInteractive = true, onExit, onBack, onDev, onD
message={`Added memory: ${flow.memoryName}`}
detail="Memory added to project in `agentcore/agentcore.json`."
summary={
<Text color="yellow">
Note: Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
<Box flexDirection="column">
<Text color="yellow">
Note: See{' '}
<Link url="https://github.com/aws/agentcore-cli/blob/main/docs/memory.md#swapping-or-changing-memory-strands">
<Text color="cyan">docs/memory.md</Text>
</Link>{' '}
to learn how to connect memory to your agent.
</Text>
<Text color="yellow">
Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
</Box>
}
onAddAnother={onBack}
onDev={onDev}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); chore: add memory documentation hints to CLI output by aidandaly24 · Pull Request #227 · aws/agentcore-cli · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions docs/memory.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,115 @@ agentcore add memory \
--owner MyAgent
```

## Swapping or Changing Memory (Strands)

For Strands agents, when you create an agent with memory, the CLI generates a `memory/session.py` file that references a
specific memory via environment variable. To swap which memory your agent uses:

### Step 1: Check Available Memories

Look at your `agentcore/agentcore.json` to see defined memories:

```json
{
"memories": [
{ "name": "MyAgentMemory", ... },
{ "name": "SharedMemory", ... },
{ "name": "UserPrefMemory", ... }
]
}
```

Each memory gets an environment variable: `MEMORY_<NAME>_ID` (uppercase, underscores).

### Step 2: Update session.py

Edit `app/<YourAgent>/memory/session.py` and change the `MEMORY_ID` line:

```python
# Before: using MyAgentMemory
MEMORY_ID = os.getenv("MEMORY_MYAGENTMEMORY_ID")

# After: switch to SharedMemory
MEMORY_ID = os.getenv("MEMORY_SHAREDMEMORY_ID")
```

### Step 3: Redeploy

```bash
agentcore deploy
```

### Adding Memory to an Agent Without Memory (Strands)

If you created an agent without memory and want to add it later:

1. Add a memory to your project:

```bash
agentcore add memory --name MyMemory --strategies SEMANTIC
```

2. Create the `memory/` directory in your agent:

```bash
mkdir -p app/MyAgent/memory
```

3. Create `app/MyAgent/memory/session.py`:

```python
import os
from typing import Optional
from bedrock_agentcore.memory.integrations.strands.config import AgentCoreMemoryConfig, RetrievalConfig
from bedrock_agentcore.memory.integrations.strands.session_manager import AgentCoreMemorySessionManager

MEMORY_ID = os.getenv("MEMORY_MYMEMORY_ID")
REGION = os.getenv("AWS_REGION")

def get_memory_session_manager(session_id: str, actor_id: str) -> Optional[AgentCoreMemorySessionManager]:
if not MEMORY_ID:
return None

retrieval_config = {
f"/users/{actor_id}/facts": RetrievalConfig(top_k=3, relevance_score=0.5),
f"/users/{actor_id}/preferences": RetrievalConfig(top_k=3, relevance_score=0.5),
}

return AgentCoreMemorySessionManager(
AgentCoreMemoryConfig(
memory_id=MEMORY_ID,
session_id=session_id,
actor_id=actor_id,
retrieval_config=retrieval_config,
),
REGION
)
```

4. Update `main.py` to use the session manager:

```python
from memory.session import get_memory_session_manager

@app.entrypoint
async def invoke(payload, context):
session_id = getattr(context, 'session_id', 'default-session')
user_id = getattr(context, 'user_id', 'default-user')
session_manager = get_memory_session_manager(session_id, user_id)

agent = Agent(
model=load_model(),
session_manager=session_manager, # Add this line
...
)
```

5. Deploy:
```bash
agentcore deploy
```

## Memory Strategies

| Strategy | Description |
Expand Down
41 changes: 39 additions & 2 deletions src/cli/tui/screens/add/AddFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import { AddSuccessScreen } from './AddSuccessScreen';
import { AddTargetScreen } from './AddTargetScreen';
import { useAddTarget, useExistingTargets } from './useAddTarget';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -254,13 +255,29 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-create-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Created agent: ${flow.agentName}`}
summary={
!flow.loading && (
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} projectPath={flow.projectPath} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
Expand All@@ -278,11 +295,31 @@ export function AddFlow(props: AddFlowProps) {
}

if (flow.name === 'agent-byo-success') {
const memoryDocAnchor =
flow.config.memory !== 'none'
? '#swapping-or-changing-memory-strands'
: '#adding-memory-to-an-agent-without-memory-strands';
const memoryNotePrefix =
flow.config.memory !== 'none' ? 'To swap or change memory later, see ' : 'To add memory later, see ';
return (
<AddSuccessScreen
isInteractive={props.isInteractive}
message={`Added agent: ${flow.agentName}`}
summary={!flow.loading && <AgentAddedSummary config={flow.config} projectName={flow.projectName} />}
summary={
!flow.loading && (
<Box flexDirection="column">
<AgentAddedSummary config={flow.config} projectName={flow.projectName} />
<Box marginTop={1}>
<Text color="yellow">
Note: {memoryNotePrefix}
<Link url={`https://github.com/aws/agentcore-cli/blob/main/docs/memory.md${memoryDocAnchor}`}>
<Text color="cyan">docs/memory.md</Text>
</Link>
</Text>
</Box>
</Box>
)
}
detail="Deploy with `agentcore deploy`."
loading={flow.loading}
loadingMessage={flow.loadingMessage}
Expand Down
20 changes: 15 additions & 5 deletions src/cli/tui/screens/memory/AddMemoryFlow.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@ import { useCreateMemory, useExistingMemoryNames } from '../../hooks/useCreateMe
import { AddSuccessScreen } from '../add/AddSuccessScreen';
import { AddMemoryScreen } from './AddMemoryScreen';
import type { AddMemoryConfig } from './types';
import { Text } from 'ink';
import { Box, Text } from 'ink';
import Link from 'ink-link';
import React, { useCallback, useEffect, useState } from 'react';

type FlowState =
Expand DownExpand Up@@ -60,10 +61,19 @@ export function AddMemoryFlow({ isInteractive = true, onExit, onBack, onDev, onD
message={`Added memory: ${flow.memoryName}`}
detail="Memory added to project in `agentcore/agentcore.json`."
summary={
<Text color="yellow">
Note: Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
<Box flexDirection="column">
<Text color="yellow">
Note: See{' '}
<Link url="https://github.com/aws/agentcore-cli/blob/main/docs/memory.md#swapping-or-changing-memory-strands">
<Text color="cyan">docs/memory.md</Text>
</Link>{' '}
to learn how to connect memory to your agent.
</Text>
<Text color="yellow">
Once you deploy, the memory resource will be created in your account, but it is not automatically
connected to your agent. You must configure your agent code to use this memory.
</Text>
</Box>
}
onAddAnother={onBack}
onDev={onDev}
Expand Down
Loading