Skip to content

Commit 552f34d

Browse files
abrookinsclaude
andcommitted
Fix documentation links and update API section naming
- Update README documentation links to point to full docs site instead of local files - Add note about MCP/SDK tool calls vs direct client function calls - Rename "API Interfaces" to "API Reference" across all documentation - Apply ruff code formatting fixes 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 3e975a5 commit 552f34d

File tree

4 files changed

+12
-10
lines changed

4 files changed

+12
-10
lines changed

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ ENABLE_TOPIC_EXTRACTION=true
222222
ENABLE_NER=true
223223
```
224224

225-
## API Interfaces
225+
## API Reference
226226

227227
### REST API (Port 8000)
228228
- Session management (`/v1/working-memory/`)

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ results = await client.search_long_term_memory(
5757
)
5858
```
5959

60+
> **Note**: While you can call client functions directly as shown above, using **MCP or SDK-provided tool calls** is recommended for AI agents as it provides better integration, automatic context management, and follows AI-native patterns. See **[Memory Patterns](https://redis.github.io/agent-memory-server/memory-patterns/)** for guidance on when to use each approach.
61+
6062
### 3. MCP Integration
6163

6264
```bash
@@ -73,13 +75,13 @@ uv run agent-memory mcp --mode sse --port 9000
7375

7476
### Key Documentation Sections:
7577

76-
- **[Quick Start Guide](docs/quick-start.md)** - Get up and running in minutes
77-
- **[Python SDK](docs/python-sdk.md)** - Complete SDK reference with examples
78-
- **[Vector Store Backends](docs/vector-store-backends.md)** - Configure different vector databases
79-
- **[Authentication](docs/authentication.md)** - OAuth2/JWT setup for production
80-
- **[Memory Types](docs/memory-types.md)** - Understanding semantic vs episodic memory
81-
- **[API Reference](docs/api.md)** - REST API endpoints
82-
- **[MCP Protocol](docs/mcp.md)** - Model Context Protocol integration
78+
- **[Quick Start Guide](https://redis.github.io/agent-memory-server/quick-start/)** - Get up and running in minutes
79+
- **[Python SDK](https://redis.github.io/agent-memory-server/python-sdk/)** - Complete SDK reference with examples
80+
- **[Vector Store Backends](https://redis.github.io/agent-memory-server/vector-store-backends/)** - Configure different vector databases
81+
- **[Authentication](https://redis.github.io/agent-memory-server/authentication/)** - OAuth2/JWT setup for production
82+
- **[Memory Types](https://redis.github.io/agent-memory-server/memory-types/)** - Understanding semantic vs episodic memory
83+
- **[API Reference](https://redis.github.io/agent-memory-server/api/)** - REST API endpoints
84+
- **[MCP Protocol](https://redis.github.io/agent-memory-server/mcp/)** - Model Context Protocol integration
8385

8486
## Architecture
8587

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Understand the fundamentals:
2828
- **[Recency Boost](recency-boost.md)** - Time-aware memory ranking and intelligent scoring
2929
- **[Vector Store Backends](vector-store-backends.md)** - Alternative storage backends (Pinecone, Chroma, etc.)
3030

31-
## 🔌 API Interfaces
31+
## 🔌 API Reference
3232

3333
Choose your integration approach:
3434

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ nav:
100100
- Advanced Vector Store Config: vector-store-advanced.md
101101
- Contextual Grounding: contextual-grounding.md
102102

103-
- API Interfaces:
103+
- API Reference:
104104
- REST API: api.md
105105
- MCP Server: mcp.md
106106
- CLI Reference: cli.md

0 commit comments

Comments
 (0)