Skip to content

Commit 1a6aa68

Browse files
phernandezclaude
andcommitted
docs: update folder -> directory in documentation and fix canvas examples
- Update CLAUDE.md tool signature from folder to directory for canvas tool - Fix canvas.py docstring examples to use correct parameter order (project is an optional keyword arg, not the first positional arg) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: phernandez <paul@basicmachines.co>
1 parent 3604da1 commit 1a6aa68

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

CLAUDE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -248,12 +248,12 @@ See SPEC-16 for full context manager refactor details.
248248
- Basic Memory exposes these MCP tools to LLMs:
249249

250250
**Content Management:**
251-
- `write_note(title, content, folder, tags)` - Create/update markdown notes with semantic observations and relations
251+
- `write_note(title, content, directory, tags)` - Create/update markdown notes with semantic observations and relations
252252
- `read_note(identifier, page, page_size)` - Read notes by title, permalink, or memory:// URL with knowledge graph awareness
253253
- `read_content(path)` - Read raw file content (text, images, binaries) without knowledge graph processing
254254
- `view_note(identifier, page, page_size)` - View notes as formatted artifacts for better readability
255255
- `edit_note(identifier, operation, content)` - Edit notes incrementally (append, prepend, find/replace, replace_section)
256-
- `move_note(identifier, destination_path)` - Move notes to new locations, updating database and maintaining links
256+
- `move_note(identifier, destination_path, is_directory)` - Move notes or directories to new locations, updating database and maintaining links
257257
- `delete_note(identifier)` - Delete notes from the knowledge base
258258

259259
**Knowledge Graph Navigation:**
@@ -270,7 +270,7 @@ See SPEC-16 for full context manager refactor details.
270270
- `delete_project(project_name)` - Delete a project from configuration
271271

272272
**Visualization:**
273-
- `canvas(nodes, edges, title, folder)` - Generate Obsidian canvas files for knowledge graph visualization
273+
- `canvas(nodes, edges, title, directory)` - Generate Obsidian canvas files for knowledge graph visualization
274274

275275
**ChatGPT-Compatible Tools:**
276276
- `search(query)` - Search across knowledge base (OpenAI actions compatible)

src/basic_memory/mcp/tools/canvas.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,11 @@ async def canvas(
8585
```
8686
8787
Examples:
88-
# Create canvas in project
89-
canvas("my-project", nodes=[...], edges=[...], title="My Canvas", directory="diagrams")
88+
# Create canvas in default/current project
89+
canvas(nodes=[...], edges=[...], title="My Canvas", directory="diagrams")
9090
91-
# Create canvas in work project
92-
canvas("work-project", nodes=[...], edges=[...], title="Process Flow", directory="visual/maps")
91+
# Create canvas with explicit project
92+
canvas(nodes=[...], edges=[...], title="Process Flow", directory="visual/maps", project="work-project")
9393
9494
Raises:
9595
ToolError: If project doesn't exist or directory path is invalid

0 commit comments

Comments
 (0)