Skip to content

Commit 3e9aaa2

Browse files
committed
update docs for clarity
1 parent b5c77f4 commit 3e9aaa2

File tree

4 files changed

+69
-18
lines changed

4 files changed

+69
-18
lines changed

src/pages/getting-started.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,9 +151,9 @@ basic-memory project add "work-notes" ~/Documents/work
151151
You: "Create a new project called 'work-notes' in ~/Documents/work"
152152
```
153153

154-
**Single project users:**
154+
**For users who primarily work in one project:**
155155

156-
If you only use one project, you can skip the project selection prompt. Add this to `~/.basic-memory/config.json`:
156+
Enable Default Project Mode to automatically use your main project. Add this to `~/.basic-memory/config.json`:
157157

158158
```json
159159
{
@@ -162,7 +162,7 @@ If you only use one project, you can skip the project selection prompt. Add this
162162
}
163163
```
164164

165-
With this enabled, the AI uses your default project automatically without asking.
165+
With this enabled, the AI uses your default project automatically when no project is specified. You can still override this by explicitly specifying a different project when needed.
166166

167167
## Creating Your First Knowledge Note
168168

src/pages/guides/mcp-tools-reference.mdx

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -117,19 +117,69 @@ Assistant: Perfect! I'll use the 'research' project for our work.
117117
[Uses project="research" in all subsequent tool calls]
118118
```
119119

120-
### Project Modes
120+
### Default Project Mode
121121

122-
For detailed information about project modes (default project mode, constrained mode, etc.), see the [User Guide - Multi-Project Features](/user-guide#multi-project-features).
122+
**For single-project users who want automatic project selection:**
123+
124+
Enable in `~/.basic-memory/config.json`:
125+
```json
126+
{
127+
"default_project_mode": true,
128+
"default_project": "main"
129+
}
130+
```
131+
132+
**Behavior:**
133+
- Tools automatically use your default project when no `project` parameter is specified
134+
- You **can still override** by explicitly passing a different project to tools
135+
- Best for users who primarily work in one project but occasionally need others
136+
137+
**Example:**
138+
```
139+
# With default_project_mode enabled and default_project="main"
140+
write_note("My Note", "Content", "folder") # Uses "main" project
141+
write_note("Work Note", "Content", "folder", project="work") # Uses "work" project
142+
```
143+
144+
### Single Project Mode
145+
146+
**For locked, single-project sessions:**
147+
148+
Start MCP server with `--project` flag:
149+
```bash
150+
basic-memory mcp --project work
151+
```
152+
153+
**Behavior:**
154+
- **Locks** the entire MCP session to one project
155+
- The `project` parameter in tool calls is **ignored** - cannot switch projects
156+
- Best for automation, focused sessions, or restricted access scenarios
157+
158+
**Example:**
159+
```bash
160+
# Start locked to "work" project
161+
basic-memory mcp --project work
162+
163+
# All operations use "work" regardless of parameters
164+
write_note("My Note", "Content", "folder") # Uses "work"
165+
write_note("Note", "Content", "folder", project="personal") # Still uses "work"!
166+
```
123167

124168
### Project Resolution Hierarchy
125169

126170
When multiple project specifications exist, Basic Memory uses this priority order:
127171

128-
1. **CLI Constraint** (highest priority) - `--project` parameter
172+
1. **Single Project Mode** (highest priority) - `--project` CLI parameter or `BASIC_MEMORY_MCP_PROJECT` env var
129173
2. **Explicit Parameter** (medium priority) - `project` parameter in tool call
130-
3. **Default Project Mode** (lowest priority) - Automatic default when enabled
174+
3. **Default Project Mode** (lowest priority) - Automatic default when `default_project_mode=true`
175+
176+
**Quick Comparison:**
131177

132-
This ensures predictable behavior and allows explicit override when needed.
178+
| Mode | Can Switch Projects? | Use Case |
179+
|------|---------------------|----------|
180+
| Multi-Project (default) | Yes, via explicit parameters | Managing multiple knowledge bases |
181+
| Default Project Mode | Yes, can override default | Single project with occasional multi-project |
182+
| Single Project Mode | No, locked to one | Automation, security, focused sessions |
133183

134184
<CardGroup cols={2}>
135185
<Card title="list_memory_projects" icon="layers">

src/pages/user-guide.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -245,9 +245,9 @@ If you only use one project, you can skip the selection prompt. Add this to `~/.
245245
}
246246
```
247247

248-
With this enabled, the AI uses your default project automatically without asking.
248+
With this enabled, the AI uses your default project automatically without asking. You can still override this by explicitly specifying a different project in tool calls.
249249

250-
### Constrained Project Mode
250+
### Single Project Mode
251251

252252
For focused work sessions or automation, you can lock the MCP server to a specific project:
253253

@@ -256,15 +256,16 @@ For focused work sessions or automation, you can lock the MCP server to a specif
256256
basic-memory mcp --project work-notes
257257
```
258258

259+
This **locks** the entire MCP session to one project - the `project` parameter in tool calls will be ignored.
260+
259261
**When to use:**
260262
- Automation workflows that should only access one project
261263
- Focused work sessions where you want to prevent accidental cross-project operations
262264
- Team environments with project-specific access
263265

264-
**Benefits:**
265-
- All tools automatically operate within the specified project
266-
- No risk of accidentally modifying the wrong project
267-
- Simplified workflow for single-project tasks
266+
**Key difference from Default Project Mode:**
267+
- **Single Project Mode**: Locks session to one project, cannot switch
268+
- **Default Project Mode**: Uses default automatically, but can still switch projects
268269

269270
<Warning>
270271
Moving notes from one project to another is not currently supported. The easiest

src/pages/whats-new.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ If you only use one project, enable automatic project selection:
6767
```
6868

6969
With this enabled:
70-
- AI uses your default project automatically
71-
- No project selection prompt
72-
- Suitable for single knowledge base workflows
70+
- AI uses your default project automatically when no project is specified
71+
- You can still override by explicitly passing a different project to tools
72+
- Suitable for users who primarily work in one project
7373

7474
#### Single Project Mode
7575

@@ -79,7 +79,7 @@ Lock an MCP session to a specific project using the `--project` flag:
7979
basic-memory mcp --project work-notes
8080
```
8181

82-
All operations in this session use the specified project. Useful for automation and focused work sessions.
82+
**Key behavior:** All operations in this session use the specified project - the `project` parameter in tool calls is ignored. Useful for automation, security, and focused work sessions where you want to prevent accidental cross-project operations.
8383

8484
#### What Changed from v0.14.x
8585

0 commit comments

Comments
 (0)