Skip to content

Commit 182ec78

Browse files
author
phernandez
committed
docs: update README.md and CLAUDE.md
1 parent f8078cd commit 182ec78

2 files changed

Lines changed: 328 additions & 128 deletions

File tree

CLAUDE.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ be traversed using links between documents.
88

99
## CODEBASE DEVELOPMENT
1010

11+
### Project information
12+
13+
See the [README.md](README.md) file for a project overview.
14+
1115
### Build and Test Commands
1216

1317
- Install: `make install` or `pip install -e ".[dev]"`
@@ -32,7 +36,7 @@ be traversed using links between documents.
3236
- CLI uses Typer for command structure
3337
- API uses FastAPI for endpoints
3438
- Follow the repository pattern for data access
35-
- Tools communicate to api routers via the httpx asgi client (in process)
39+
- Tools communicate to api routers via the httpx ASGI client (in process)
3640

3741
### Codebase Architecture
3842

@@ -53,11 +57,13 @@ be traversed using links between documents.
5357
- MCP prompts are defined in src/basic_memory/mcp/prompts/
5458
- MCP tools should be atomic, composable operations
5559
- Use `textwrap.dedent()` for multi-line string formatting in prompts and tools
56-
- Prompts are special types of tools that format content for user consumption
60+
- MCP Prompts are used to invoke tools and format content with instructions for an LLM
5761
- Schema changes require Alembic migrations
5862
- SQLite is used for indexing and full text search, files are source of truth
5963
- Testing uses pytest with asyncio support (strict mode)
6064
- Test database uses in-memory SQLite
65+
- Avoid creating mocks in tests in most circumstances.
66+
- Each test runs in a standalone enviroment with in memory SQLite and tmp_file directory
6167

6268
## BASIC MEMORY PRODUCT USAGE
6369

@@ -87,19 +93,22 @@ be traversed using links between documents.
8793

8894
- Basic Memory exposes these MCP tools to LLMs:
8995

90-
**Content Management:**
96+
**Content Management:**
9197
- `write_note(title, content, folder, tags)` - Create/update markdown notes with semantic observations and relations
92-
- `read_note(identifier, page, page_size)` - Read notes by title, permalink, or memory:// URL with knowledge graph awareness
98+
- `read_note(identifier, page, page_size)` - Read notes by title, permalink, or memory:// URL with knowledge graph
99+
awareness
93100
- `read_file(path)` - Read raw file content (text, images, binaries) without knowledge graph processing
94101

95-
**Knowledge Graph Navigation:**
96-
- `build_context(url, depth, timeframe)` - Navigate the knowledge graph via memory:// URLs for conversation continuity
97-
- `recent_activity(type, depth, timeframe)` - Get recently updated information with specified timeframe (e.g., "1d", "1 week")
98-
99-
**Search & Discovery:**
102+
**Knowledge Graph Navigation:**
103+
- `build_context(url, depth, timeframe)` - Navigate the knowledge graph via memory:// URLs for conversation
104+
continuity
105+
- `recent_activity(type, depth, timeframe)` - Get recently updated information with specified timeframe (e.g., "
106+
1d", "1 week")
107+
108+
**Search & Discovery:**
100109
- `search(query, page, page_size)` - Full-text search across all content with filtering options
101-
102-
**Visualization:**
110+
111+
**Visualization:**
103112
- `canvas(nodes, edges, title, folder)` - Generate Obsidian canvas files for knowledge graph visualization
104113

105114
- MCP Prompts for better AI interaction:
@@ -111,12 +120,14 @@ be traversed using links between documents.
111120

112121
## AI-Human Collaborative Development
113122

114-
Basic Memory emerged from and enables a new kind of development process that combines human and AI capabilities. Instead of using AI just for code generation, we've developed a true collaborative workflow:
123+
Basic Memory emerged from and enables a new kind of development process that combines human and AI capabilities. Instead
124+
of using AI just for code generation, we've developed a true collaborative workflow:
115125

116-
1. AI (Claude) writes initial implementation based on specifications and context
126+
1. AI (LLM) writes initial implementation based on specifications and context
117127
2. Human reviews, runs tests, and commits code with any necessary adjustments
118128
3. Knowledge persists across conversations using Basic Memory's knowledge graph
119129
4. Development continues seamlessly across different AI sessions with consistent context
120130
5. Results improve through iterative collaboration and shared understanding
121131

122-
This approach has allowed us to tackle more complex challenges and build a more robust system than either humans or AI could achieve independently.
132+
This approach has allowed us to tackle more complex challenges and build a more robust system than either humans or AI
133+
could achieve independently.

0 commit comments

Comments
 (0)