mnotes-cli 1.5.1 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +1 -1
- package/dist/templates/claude-code.js +55 -2
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -15,7 +15,7 @@ const program = new commander_1.Command();
|
|
|
15
15
|
program
|
|
16
16
|
.name("mnotes")
|
|
17
17
|
.description("CLI for m-notes AI knowledge base")
|
|
18
|
-
.version(
|
|
18
|
+
.version(require("../package.json").version)
|
|
19
19
|
.option("--api-key <key>", "API key (or set MNOTES_API_KEY)")
|
|
20
20
|
.option("--url <url>", "Base URL (or set MNOTES_URL)")
|
|
21
21
|
.option("--json", "Output as JSON");
|
|
@@ -38,17 +38,70 @@ Recall knowledge **before acting**. Specifically:
|
|
|
38
38
|
- At session start → \`project_context_load\` loads everything relevant
|
|
39
39
|
- When the user asks about past work → \`session_context_resume\`
|
|
40
40
|
|
|
41
|
+
## Notes — Your Working Documents
|
|
42
|
+
|
|
43
|
+
m-notes is not just a knowledge base — it's a full note-taking system. **Use notes actively** to create and maintain living documents:
|
|
44
|
+
|
|
45
|
+
### When to Create Notes
|
|
46
|
+
- **Meeting notes** → \`create_note\` after any planning discussion or decision
|
|
47
|
+
- **Investigation logs** → create a note when debugging, append findings as you go with \`append_to_note\`
|
|
48
|
+
- **Design docs** → write architecture or design decisions as full notes, not just knowledge entries
|
|
49
|
+
- **Task summaries** → after completing a story/task, create a note summarizing what was done
|
|
50
|
+
- **Checklists and plans** → create notes with markdown checklists for multi-step work
|
|
51
|
+
- **Daily notes** → use \`daily_note\` to create/get today's note for quick captures
|
|
52
|
+
|
|
53
|
+
### When to Edit Notes
|
|
54
|
+
- **Append progress** → use \`append_to_note\` to add to existing notes as work progresses
|
|
55
|
+
- **Update docs** → when code changes invalidate existing notes, update them with \`update_note\`
|
|
56
|
+
- **Tag and organize** → use \`manage_tags\` and folder tools to keep notes findable
|
|
57
|
+
|
|
58
|
+
### Note vs Knowledge Entry
|
|
59
|
+
| Use a **note** when... | Use **knowledge_store** when... |
|
|
60
|
+
|---|---|
|
|
61
|
+
| Content is long-form (paragraphs, lists, docs) | Content is a single fact or decision |
|
|
62
|
+
| Document will be updated over time | Entry is a permanent record |
|
|
63
|
+
| Needs folder organization | Needs key/tag retrieval |
|
|
64
|
+
| Meeting notes, plans, investigations | Architecture decisions, gotchas, patterns |
|
|
65
|
+
|
|
66
|
+
**When in doubt, create a note.** Notes are searchable, linkable, and visible in the UI.
|
|
67
|
+
|
|
41
68
|
## MCP Tools Reference
|
|
42
69
|
|
|
70
|
+
### Session & Context
|
|
43
71
|
| Tool | When to use |
|
|
44
72
|
|------|------------|
|
|
45
73
|
| \`project_context_load\` | Session start — loads project context |
|
|
46
74
|
| \`session_context_resume\` | Resume from previous session |
|
|
47
|
-
| \`
|
|
75
|
+
| \`session_log\` | Log session summary at end |
|
|
76
|
+
|
|
77
|
+
### Knowledge (quick structured entries)
|
|
78
|
+
| Tool | When to use |
|
|
79
|
+
|------|------------|
|
|
80
|
+
| \`knowledge_store\` | Store a knowledge entry (key, content, tags) |
|
|
48
81
|
| \`recall_knowledge\` | Semantic search across stored knowledge |
|
|
49
82
|
| \`bulk_knowledge_recall\` | Recall by tag patterns (e.g., all \`arch/*\`) |
|
|
50
83
|
| \`knowledge_snapshot\` | Export all knowledge at once |
|
|
51
|
-
|
|
84
|
+
|
|
85
|
+
### Notes (full documents)
|
|
86
|
+
| Tool | When to use |
|
|
87
|
+
|------|------------|
|
|
88
|
+
| \`create_note\` | Create a new note (title, content, folderId) |
|
|
89
|
+
| \`update_note\` | Replace note content |
|
|
90
|
+
| \`append_to_note\` | Add content to an existing note |
|
|
91
|
+
| \`get_note\` | Read a note by ID |
|
|
92
|
+
| \`get_note_by_title\` | Find a note by title |
|
|
93
|
+
| \`search_notes\` | Full-text or semantic search |
|
|
94
|
+
| \`list_notes\` | List notes in a folder |
|
|
95
|
+
| \`daily_note\` | Create or get today's daily note |
|
|
96
|
+
| \`manage_tags\` | Add/remove tags on notes |
|
|
97
|
+
| \`pin_note\` / \`toggle_star\` | Pin or star important notes |
|
|
98
|
+
|
|
99
|
+
### Organization
|
|
100
|
+
| Tool | When to use |
|
|
101
|
+
|------|------------|
|
|
102
|
+
| \`list_folders\` | List folders in workspace |
|
|
103
|
+
| \`create_folder\` | Create a new folder |
|
|
104
|
+
| \`move_note\` | Move note to a different folder |
|
|
52
105
|
| \`context_fetch\` | Search notes by query |
|
|
53
106
|
|
|
54
107
|
All tools require \`workspaceId: "${opts.workspaceId}"\`.`;
|