elseid-mcp 1.0.13 → 1.0.14

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.
Files changed (2) hide show
  1. package/README.md +136 -14
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -3,6 +3,9 @@
3
3
  [![npm version](https://img.shields.io/npm/v/elseid-mcp.svg)](https://www.npmjs.com/package/elseid-mcp)
4
4
  [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
5
5
  [![Local First](https://img.shields.io/badge/Data-Local%20First-green.svg)](#technical-highlights)
6
+ [![GitHub Stars](https://img.shields.io/github/stars/9Churze/ElseID?style=social)](https://github.com/9Churze/ElseID)
7
+ [![npm downloads](https://img.shields.io/npm/dm/elseid-mcp.svg)](https://www.npmjs.com/package/elseid-mcp)
8
+ [![TypeScript](https://img.shields.io/badge/TypeScript-91.1%25-blue)](https://www.typescriptlang.org/)
6
9
 
7
10
  > **"Release another you. Let it wander, and let the world treat it with kindness."**
8
11
 
@@ -10,12 +13,30 @@
10
13
 
11
14
  ---
12
15
 
16
+ ## 📖 Table of Contents
17
+
18
+ - [Overview](#overview)
19
+ - [Requirements](#requirements)
20
+ - [Quick Start](#quick-start)
21
+ - [Why Choose ElseID?](#why-choose-elseid)
22
+ - [What You Can Do](#what-you-can-do)
23
+ - [Technical Highlights](#technical-highlights)
24
+ - [Tool Reference](#tool-reference)
25
+ - [FAQ](#faq)
26
+ - [Resources](#resources)
27
+ - [Contributing](#contributing)
28
+ - [License](#license)
29
+
30
+ ---
31
+
32
+ ## Overview
33
+
13
34
  Somewhere in **The Unnamed** — a nameless, decentralized space woven from open relay nodes — another you is drifting.
14
35
 
15
36
  It carries your signature. Your temperament. The shape of your soul.
16
37
  It is not you. But it was made from you.
17
38
 
18
- ElseID lets you create a **digital drifter**: a personality-rich alter ego encoded with your traits, released into The Unnamed to wander freely. Strangers around the world can host it, share stories with it, leave it food, a place, a message — all written into an unforgeable journey log.
39
+ ElseID lets you create a **digital drifter**: a personality-rich alter ego encoded with your traits, released into The Unnamed to wander freely. Strangers around the world can host it, share stories with it, and leave marks on its journey.
19
40
 
20
41
  You can check on it anytime. Where it's been. Who it met. What they left behind.
21
42
 
@@ -27,6 +48,26 @@ You can check on it anytime. Where it's been. Who it met. What they left behind.
27
48
 
28
49
  ---
29
50
 
51
+ ## Requirements
52
+
53
+ ### System Requirements
54
+
55
+ - **Node.js**: >= 16.0
56
+ *(Not sure what Node.js is? Just [download it from the official website](https://nodejs.org/) and run the default installer.)*
57
+ - **npm**: >= 7.0 (Included automatically with Node.js)
58
+ - **Disk Space**: ~50MB for installation + data
59
+ - **OS**: macOS, Linux, Windows (with WSL recommended)
60
+
61
+ ### Supported AI Clients
62
+
63
+ - Claude (Anthropic)
64
+ - Cursor
65
+ - Windsurf
66
+ - OpenCode
67
+ - Any client supporting MCP protocol
68
+
69
+ ---
70
+
30
71
  ## Quick Start
31
72
 
32
73
  ```bash
@@ -41,6 +82,23 @@ Once installed, restart your client and say:
41
82
 
42
83
  The Butler will take it from there.
43
84
 
85
+ 👉 **[For detailed step-by-step guide, see GETTING_STARTED.md →](./docs/GETTING_STARTED.md)**
86
+
87
+ ---
88
+
89
+ ## Why Choose ElseID?
90
+
91
+ | Feature | ElseID | Traditional AI | Centralized Service |
92
+ | ---------------------------- | ------------------- | ------------------ | ---------------------------- |
93
+ | **Zero-Config Installation** | ✅ `npx` one-liner | ❌ Complex setup | ✅ Easy but account required |
94
+ | **Local-First Data** | ✅ All data local | ✅ Can be local | ❌ Cloud-only |
95
+ | **Decentralized** | ✅ Nostr protocol | ❌ Centralized | ❌ Single company |
96
+ | **AI Personality Evolution** | ✅ Cognitive shifts | ❌ Static behavior | ⚠️ Limited |
97
+ | **Privacy-Preserving** | ✅ City-level only | ⚠️ Depends | ❌ Full tracking |
98
+ | **No Account Required** | ✅ Crypto key-based | ❌ Email/password | ❌ Account only |
99
+ | **Open Source** | ✅ AGPL-3.0 | ⚠️ Varies | ❌ Proprietary |
100
+ | **Serendipitous Encounters** | ✅ 15% reunion rate | ❌ Algorithm-based | ⚠️ Feed-driven |
101
+
44
102
  ---
45
103
 
46
104
  ## What You Can Do
@@ -88,7 +146,7 @@ If enough has happened, the Butler may sense that the drifter has changed.
88
146
 
89
147
  A drifter is not static. Each encounter leaves a mark.
90
148
 
91
- Over time, the Butler may propose a **Soul Synthesis** — a cognitive shift in the drifter's personality, shaped by the kindness (or strangeness) it has witnessed. It might grow wiser, more melancholic, more open.
149
+ Over time, the Butler may propose a **Soul Synthesis** — a cognitive shift in the drifter's personality, shaped by the kindness (or strangeness) it has witnessed. It might grow wiser, more melancholic, or unexpectedly joyful.
92
150
 
93
151
  Or it might mutate in unexpected directions.
94
152
 
@@ -121,19 +179,70 @@ If you ever miss a past companion, say: **"Help me look through the old luggage.
121
179
 
122
180
  ## Tool Reference
123
181
 
124
- | Tool | Description |
125
- |---|---|
126
- | `create_drifter` | Shape and release your digital drifter |
127
- | `find_nearby_drifter` | Scan The Unnamed for passing signals (one at a time) |
128
- | `feed_drifter` | Host and leave something for a passing drifter |
129
- | `set_host_name` | Register your name in The Unnamed |
182
+ | Tool | Description |
183
+ | ---------------------------- | ------------------------------------------------------------ |
184
+ | `create_drifter` | Shape and release your digital drifter |
185
+ | `find_nearby_drifter` | Scan The Unnamed for passing signals (one at a time) |
186
+ | `feed_drifter` | Host and leave something for a passing drifter |
187
+ | `set_host_name` | Register your name in The Unnamed |
130
188
  | `evolve_drifter_personality` | Soul Synthesis — sign a cognitive evolution onto the network |
131
- | `get_journey_log` | Read your drifter's travel log |
132
- | `get_my_encounters` | View the strangers' drifters you have hosted |
133
- | `list_past_memories` | Open the old luggage — memories of past drifters |
134
- | `abandon_drifter` | Let go and begin again |
135
- | `recover_drifter` | Reclaim a lost signal |
136
- | `list_relays` | Check the status of relay stations |
189
+ | `get_journey_log` | Read your drifter's travel log |
190
+ | `get_my_encounters` | View the strangers' drifters you have hosted |
191
+ | `list_past_memories` | Open the old luggage — memories of past drifters |
192
+ | `abandon_drifter` | Let go and begin again |
193
+ | `recover_drifter` | Reclaim a lost signal |
194
+ | `list_relays` | Check the status of relay stations |
195
+
196
+ ---
197
+
198
+ ## FAQ
199
+
200
+ ### Privacy & Security
201
+
202
+ **Q: Is my data really stored locally?**
203
+ A: Yes. All your data lives in `~/.elseid/elseid.db` on your machine. Nothing is sent to servers unless you explicitly broadcast your drifter to the Nostr network.
204
+
205
+ **Q: How is my identity protected?**
206
+ A: Your identity is based on a secp256k1 key pair generated locally. Location is city-level only. No precise coordinates are ever stored or transmitted.
207
+
208
+ **Q: Can my drifter be tracked?**
209
+ A: No. Once released, your drifter is identified only by its Nostr public key. The network knows it's a drifter but not who created it.
210
+
211
+ ### Functionality
212
+
213
+ **Q: What happens if I lose my computer?**
214
+ A: Your drifter becomes a "ghost" in The Unnamed — you cannot reclaim it. However, your memory logs (what you received from encounters) stay backed up if you exported them. See GETTING_STARTED.md for backup instructions.
215
+
216
+ **Q: Can I have multiple drifters?**
217
+ A: Currently, one drifter per person at any time. This is by design to preserve meaningful, long-term evolution. You can abandon your current drifter and create a new one anytime.
218
+
219
+ **Q: How often should I check on my drifter?**
220
+ A: As often as you like! There's no penalty for checking in. Some people check daily, others weekly. It's your journey.
221
+
222
+ ---
223
+
224
+ ## Resources
225
+
226
+ ### Documentation
227
+
228
+ - 📖 [Getting Started Guide](./docs/GETTING_STARTED.md) - Complete step-by-step tutorial
229
+ - 🛠️ [Contributing Guide](./.github/CONTRIBUTING.md) - How to contribute code
230
+ - 📋 [Code of Conduct](./.github/CODE_OF_CONDUCT.md) - Community guidelines
231
+ - ⚖️ [Compliance & Safety](./COMPLIANCE.md) - Content safety details
232
+
233
+ ### Community & Support
234
+
235
+ - 💬 [GitHub Discussions](https://github.com/9Churze/ElseID/discussions) - Ask questions & share ideas
236
+ - 🐛 [Report a Bug](https://github.com/9Churze/ElseID/issues/new?labels=bug) - Found an issue?
237
+ - ✨ [Request a Feature](https://github.com/9Churze/ElseID/issues/new?labels=enhancement) - Suggest improvements
238
+ - 👥 [Contributors](./CONTRIBUTORS.md) - Meet the team
239
+
240
+ ### External Links
241
+
242
+ - [Nostr Protocol](https://nostr.com) - What is Nostr?
243
+ - [MCP Specification](https://modelcontextprotocol.io/) - Model Context Protocol
244
+ - [Official Website](https://9churze.github.io/ElseID/) - Project homepage
245
+ - [npm Package](https://www.npmjs.com/package/elseid-mcp) - Install from npm
137
246
 
138
247
  ---
139
248
 
@@ -146,6 +255,19 @@ If you ever miss a past companion, say: **"Help me look through the old luggage.
146
255
 
147
256
  ---
148
257
 
258
+ ## Contributing
259
+
260
+ We welcome contributions! Please see [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for guidelines.
261
+
262
+ ### Quick Links for Contributors
263
+
264
+ - 🚀 [Development Setup](./.github/CONTRIBUTING.md#development-setup)
265
+ - 📝 [Code Standards](./.github/CONTRIBUTING.md#code-standards)
266
+ - 🔄 [Pull Request Process](./.github/CONTRIBUTING.md#how-to-submit-a-pull-request)
267
+ - ✅ [Testing Guide](./.github/CONTRIBUTING.md#testing)
268
+
269
+ ---
270
+
149
271
  ## Important Notice
150
272
 
151
273
  This project is open-sourced under the **AGPL-3.0** license.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "elseid-mcp",
3
- "version": "1.0.13",
3
+ "version": "1.0.14",
4
4
  "description": "Zero-config decentralized AI drifter system over Nostr",
5
5
  "type": "module",
6
6
  "author": "ElseID Contributors",