estatehelm 1.0.7 → 1.0.9
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 +50 -22
- package/dist/index.js +2731 -381
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -24,19 +24,27 @@ This will:
|
|
|
24
24
|
|
|
25
25
|
### 2. Configure Claude Code
|
|
26
26
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
27
|
+
**Windows:**
|
|
28
|
+
```bash
|
|
29
|
+
claude mcp add --transport stdio estatehelm -- cmd /c npx estatehelm mcp
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
**Mac/Linux:**
|
|
33
|
+
```bash
|
|
34
|
+
claude mcp add --transport stdio estatehelm -- npx estatehelm mcp
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
**For staging environment:**
|
|
38
|
+
```bash
|
|
39
|
+
# Windows
|
|
40
|
+
claude mcp add --transport stdio estatehelm-staging -- cmd /c npx estatehelm mcp --staging
|
|
41
|
+
|
|
42
|
+
# Mac/Linux
|
|
43
|
+
claude mcp add --transport stdio estatehelm-staging -- npx estatehelm mcp --staging
|
|
38
44
|
```
|
|
39
45
|
|
|
46
|
+
Verify with `claude mcp list`.
|
|
47
|
+
|
|
40
48
|
### 3. Use with Claude Code
|
|
41
49
|
|
|
42
50
|
Start Claude Code and you can now ask questions like:
|
|
@@ -122,20 +130,40 @@ The server exposes your EstateHelm data as MCP resources:
|
|
|
122
130
|
|
|
123
131
|
- `estatehelm://households` - List all households
|
|
124
132
|
- `estatehelm://households/{id}` - Specific household
|
|
125
|
-
- `estatehelm://households/{id}/
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
- `estatehelm://households/{id}/insurance` - Insurance policies
|
|
130
|
-
- `estatehelm://households/{id}/bank_account` - Bank accounts
|
|
131
|
-
- And more...
|
|
133
|
+
- `estatehelm://households/{id}/{entityType}` - Entities by type
|
|
134
|
+
|
|
135
|
+
**Supported entity types:**
|
|
136
|
+
`pet`, `property`, `vehicle`, `contact`, `insurance`, `bank_account`, `investment`, `subscription`, `maintenance_task`, `password`, `access_code`, `document`, `medical`, `prescription`, `credential`, `utility`
|
|
132
137
|
|
|
133
138
|
## MCP Tools
|
|
134
139
|
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
140
|
+
| Tool | Description | Parameters |
|
|
141
|
+
|------|-------------|------------|
|
|
142
|
+
| `search_entities` | Full-text search across entities | `query` (required), `householdId`, `entityType` |
|
|
143
|
+
| `get_household_summary` | Overview with entity counts | `householdId` (required) |
|
|
144
|
+
| `get_expiring_items` | Items expiring within N days | `days` (default: 30), `householdId` |
|
|
145
|
+
| `get_file` | Download and decrypt a file attachment | `fileId`, `householdId`, `entityId`, `entityType` (all required) |
|
|
146
|
+
| `refresh` | Force re-sync from server | none |
|
|
147
|
+
|
|
148
|
+
**`get_expiring_items` checks:**
|
|
149
|
+
- Insurance policies (`expiration_date`)
|
|
150
|
+
- Vehicle registrations (`registration_expiration`)
|
|
151
|
+
- Vehicle tabs (`tabs_expiration`)
|
|
152
|
+
- Subscriptions (`expiration_date`)
|
|
153
|
+
|
|
154
|
+
**`get_file` returns:**
|
|
155
|
+
- `fileName`: Original filename
|
|
156
|
+
- `mimeType`: File MIME type
|
|
157
|
+
- `size`: File size in bytes
|
|
158
|
+
- `data`: Base64-encoded decrypted file content
|
|
159
|
+
|
|
160
|
+
## MCP Prompts
|
|
161
|
+
|
|
162
|
+
| Prompt | Description |
|
|
163
|
+
|--------|-------------|
|
|
164
|
+
| `household_summary` | "Give me an overview of my household" |
|
|
165
|
+
| `expiring_soon` | "What's expiring in the next 30 days?" |
|
|
166
|
+
| `emergency_contacts` | "Show me emergency contacts" |
|
|
139
167
|
|
|
140
168
|
## Security
|
|
141
169
|
|