ziphro-mcp 0.0.0-stage → 2.0.0-preview.1
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 +89 -2
- package/dist/index.js +21547 -0
- package/package.json +55 -4
- package/scripts/postinstall.js +30 -0
package/README.md
CHANGED
|
@@ -1,3 +1,90 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ziphro-mcp 🪐
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> Model Context Protocol (MCP) server for Ziphro: a privacy-first task manager with client-side end-to-end zero-knowledge encryption.
|
|
4
|
+
|
|
5
|
+
This MCP server allows AI agents (like Claude Desktop, Cursor, Windsurf, Cline, etc.) to securely read, update, complete, and analyze your tasks without exposing master passwords or sensitive credentials.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 🚀 Quick Setup (Browser Pairing)
|
|
10
|
+
|
|
11
|
+
Authorize your AI agent in one click:
|
|
12
|
+
```bash
|
|
13
|
+
npx -y ziphro-mcp auth
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
This starts a local handshake receiver and opens your browser to authorize the agent. An isolated zero-knowledge API Secret (`zs_live_...`) is derived and saved to `~/.ziphro/mcp.json`. Master passwords are **never** required, requested, or stored.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## 🛠️ Running the Server
|
|
21
|
+
|
|
22
|
+
Run directly via `npx` (uses `~/.ziphro/mcp.json` automatically):
|
|
23
|
+
```bash
|
|
24
|
+
npx -y ziphro-mcp
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Or install globally:
|
|
28
|
+
```bash
|
|
29
|
+
npm install -g ziphro-mcp
|
|
30
|
+
ziphro-mcp
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## ⚙️ Client Configuration
|
|
36
|
+
|
|
37
|
+
### Claude Desktop
|
|
38
|
+
Add this to your `claude_desktop_config.json`:
|
|
39
|
+
```json
|
|
40
|
+
{
|
|
41
|
+
"mcpServers": {
|
|
42
|
+
"ziphro": {
|
|
43
|
+
"command": "npx",
|
|
44
|
+
"args": ["-y", "ziphro-mcp"]
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Or specify environment variables explicitly:
|
|
51
|
+
```json
|
|
52
|
+
{
|
|
53
|
+
"mcpServers": {
|
|
54
|
+
"ziphro": {
|
|
55
|
+
"command": "npx",
|
|
56
|
+
"args": ["-y", "ziphro-mcp"],
|
|
57
|
+
"env": {
|
|
58
|
+
"ZIPHRO_API_KEY": "zp_live_<your-api-key>",
|
|
59
|
+
"ZIPHRO_API_SECRET": "zs_live_<your-api-secret>",
|
|
60
|
+
"ZIPHRO_API": "https://api-ziphro.vercel.app"
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Cursor IDE
|
|
68
|
+
1. Open Cursor Settings -> Features -> MCP.
|
|
69
|
+
2. Click **+ Add New MCP Server**.
|
|
70
|
+
3. Command: `npx -y ziphro-mcp` (zero-config after `ziphro-mcp auth`).
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## 🔑 Available Tools
|
|
75
|
+
|
|
76
|
+
* **`list_tasks`**: List user tasks with optional status (`pending`, `in_progress`, `completed`), priority (`low`, `medium`, `high`), and tag filters.
|
|
77
|
+
* **`add_task`**: Create a new task with description, priority, due date, and tags.
|
|
78
|
+
* **`complete_task`**: Mark a task as completed with an optional note.
|
|
79
|
+
* **`get_task_stats`**: Get aggregated task completion metrics and dashboard data.
|
|
80
|
+
* **`suggest_priorities`**: Ranks active/pending tasks by priority and urgency.
|
|
81
|
+
* **`search_tasks`**: Full-text search tasks by keyword, tag, or due date range.
|
|
82
|
+
* **`update_task`**: Update description, priority, status, tags, or due date.
|
|
83
|
+
* **`bulk_complete`**: Mark multiple tasks as completed in a single action.
|
|
84
|
+
* **`get_overdue`**: Retrieve all overdue tasks past their deadlines.
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## 📄 License
|
|
89
|
+
|
|
90
|
+
MIT License.
|