karma365-mcp 2.0.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/README.md +100 -0
- package/index.js +1446 -0
- package/package.json +31 -0
package/README.md
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# KARMA 365 MCP Server
|
|
2
|
+
|
|
3
|
+
> Connect Claude, Cursor, and any MCP-compatible AI agent directly to your KARMA 365 learning workspace.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/karma365-mcp)
|
|
6
|
+
[](https://opensource.org/licenses/MIT)
|
|
7
|
+
|
|
8
|
+
## 🌟 Overview
|
|
9
|
+
|
|
10
|
+
**KARMA 365 MCP Server** enables LLMs (Claude Desktop, Cursor, Windsurf, Antigravity) to read and manage your local learning topics, subtopics, resources (YouTube, links, PDFs, code snippets, notes), and todos using the **Model Context Protocol (MCP)**.
|
|
11
|
+
|
|
12
|
+
All data is stored locally in an encrypted/standard SQLite database on your machine (`~/.karma365/karma365.db` or `%APPDATA%\karma365\karma365.db`).
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## 🚀 Quick Start
|
|
17
|
+
|
|
18
|
+
Run directly via `npx` (no installation required):
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx karma365-mcp
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Or install globally:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npm install -g karma365-mcp
|
|
28
|
+
karma365-mcp
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## ⚙️ Configuration for Claude Desktop
|
|
34
|
+
|
|
35
|
+
Add this to your `claude_desktop_config.json`:
|
|
36
|
+
|
|
37
|
+
### MacOS
|
|
38
|
+
`~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
39
|
+
|
|
40
|
+
```json
|
|
41
|
+
{
|
|
42
|
+
"mcpServers": {
|
|
43
|
+
"karma365": {
|
|
44
|
+
"command": "npx",
|
|
45
|
+
"args": ["-y", "karma365-mcp"]
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Windows
|
|
52
|
+
`%APPDATA%\Claude\claude_desktop_config.json`
|
|
53
|
+
|
|
54
|
+
```json
|
|
55
|
+
{
|
|
56
|
+
"mcpServers": {
|
|
57
|
+
"karma365": {
|
|
58
|
+
"command": "npx.cmd",
|
|
59
|
+
"args": ["-y", "karma365-mcp"]
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## 🛠️ Available MCP Tools
|
|
68
|
+
|
|
69
|
+
| Tool | Description |
|
|
70
|
+
|------|-------------|
|
|
71
|
+
| `list_major_topics` | List all major topic categories |
|
|
72
|
+
| `create_major_topic` | Create a new major category |
|
|
73
|
+
| `delete_major_topic` | Delete a major topic and its subtopics |
|
|
74
|
+
| `list_topics` | List subtopics under a category |
|
|
75
|
+
| `get_topic` | Get detailed topic info, notes, and resources |
|
|
76
|
+
| `create_topic` | Create a topic or subtopic |
|
|
77
|
+
| `delete_topic` | Delete a topic and its resources |
|
|
78
|
+
| `list_resources` | List resources (videos, links, PDFs, notes) for a topic |
|
|
79
|
+
| `add_youtube` | Attach a YouTube video to a topic |
|
|
80
|
+
| `add_link` | Save web links and articles to a topic |
|
|
81
|
+
| `add_pdf` | Attach PDF documents or study material |
|
|
82
|
+
| `add_code` | Save code snippets with syntax highlighting |
|
|
83
|
+
| `write_topic_note` | Write rich notes and documentation for a topic |
|
|
84
|
+
| `list_todos` | List learning tasks and todos |
|
|
85
|
+
| `create_todo` | Add a new todo item |
|
|
86
|
+
| `complete_todo` | Mark a todo as completed |
|
|
87
|
+
| `get_stats` | Get learning workspace statistics |
|
|
88
|
+
| `search` | Fast full-text search across all topics and resources |
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## 🔧 Environment Variables (Optional)
|
|
93
|
+
|
|
94
|
+
- `KARMA365_DB`: Path to custom SQLite database file (defaults to auto-detecting KARMA 365 app data).
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## 📄 License
|
|
99
|
+
|
|
100
|
+
MIT © [ayushkotadiya5499](https://github.com/ayushkotadiya5499)
|