@allourthings/mcp-server 0.1.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 +95 -0
- package/dist/index.js +18119 -0
- package/package.json +34 -0
package/README.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# @allourthings/mcp-server
|
|
2
|
+
|
|
3
|
+
> AI-powered household inventory, on your own storage.
|
|
4
|
+
|
|
5
|
+
An [MCP server](https://modelcontextprotocol.io) that gives your AI assistant natural language access to everything you own — appliances, furniture, subscriptions, warranties, manuals, receipts, and more. Your data stays on your own device.
|
|
6
|
+
|
|
7
|
+
## Requirements
|
|
8
|
+
|
|
9
|
+
**Desktop only** — macOS, Windows, or Linux with [Claude Desktop](https://claude.ai/download) or another MCP-compatible client. The MCP server runs as a local process; mobile AI assistant access is not currently supported. An iOS app for add/browse on mobile is in development.
|
|
10
|
+
|
|
11
|
+
## Setup
|
|
12
|
+
|
|
13
|
+
### Claude Desktop
|
|
14
|
+
|
|
15
|
+
Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
|
|
16
|
+
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"mcpServers": {
|
|
20
|
+
"allourthings": {
|
|
21
|
+
"command": "npx",
|
|
22
|
+
"args": ["-y", "@allourthings/mcp-server", "--data-dir", "~/Documents/AllOurThings"]
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Restart Claude Desktop. Your inventory vault is created automatically on first use.
|
|
29
|
+
|
|
30
|
+
### Other MCP clients
|
|
31
|
+
|
|
32
|
+
```json
|
|
33
|
+
{
|
|
34
|
+
"command": "npx",
|
|
35
|
+
"args": ["-y", "@allourthings/mcp-server", "--data-dir", "~/Documents/AllOurThings"]
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Usage
|
|
40
|
+
|
|
41
|
+
Once connected, ask your AI assistant things like:
|
|
42
|
+
|
|
43
|
+
- *"Add my Bosch washing machine, bought from John Lewis for £649 in January 2024 with a 2-year warranty"*
|
|
44
|
+
- *"What appliances do I own?"*
|
|
45
|
+
- *"What's in the kitchen?"*
|
|
46
|
+
- *"When does my TV warranty expire?"*
|
|
47
|
+
- *"Search for anything Samsung"*
|
|
48
|
+
|
|
49
|
+
## Tools
|
|
50
|
+
|
|
51
|
+
| Tool | Description |
|
|
52
|
+
|---|---|
|
|
53
|
+
| `add_item` | Add a new item to your inventory |
|
|
54
|
+
| `get_item` | Retrieve an item by ID or name |
|
|
55
|
+
| `list_items` | List all items, optionally filtered by category, location, or tags |
|
|
56
|
+
| `update_item` | Update fields on an existing item |
|
|
57
|
+
| `delete_item` | Delete an item by ID |
|
|
58
|
+
| `search_items` | Full-text search across all item fields |
|
|
59
|
+
|
|
60
|
+
## Vault structure
|
|
61
|
+
|
|
62
|
+
Your inventory lives in a plain directory. Each item gets its own folder:
|
|
63
|
+
|
|
64
|
+
```
|
|
65
|
+
~/Documents/AllOurThings/
|
|
66
|
+
items/
|
|
67
|
+
dyson-v15-detect-a1b2c3d4/
|
|
68
|
+
item.json
|
|
69
|
+
manual.pdf
|
|
70
|
+
receipt.jpg
|
|
71
|
+
samsung-65-qled-tv-b5c6d7e8/
|
|
72
|
+
item.json
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Attachments (manuals, receipts, photos) sit alongside the item JSON. The vault is plain files — browse it in Finder, back it up with Time Machine, or sync it with any tool you like.
|
|
76
|
+
|
|
77
|
+
## Configuration
|
|
78
|
+
|
|
79
|
+
| Method | Example |
|
|
80
|
+
|---|---|
|
|
81
|
+
| `--data-dir` arg *(recommended)* | `--data-dir ~/Documents/AllOurThings` |
|
|
82
|
+
| `ALLOURTHINGS_DATA_DIR` env var | `ALLOURTHINGS_DATA_DIR=~/Documents/AllOurThings` |
|
|
83
|
+
| Default (no config needed) | `~/Documents/AllOurThings` |
|
|
84
|
+
|
|
85
|
+
## Item schema
|
|
86
|
+
|
|
87
|
+
Required fields: `id`, `name`, `created_at`, `updated_at`
|
|
88
|
+
|
|
89
|
+
Well-known optional fields: `category` `brand` `model` `purchase_date` `purchase_price` `currency` `warranty_expires` `retailer` `location` `features` `notes` `tags` `attachments`
|
|
90
|
+
|
|
91
|
+
Custom fields are preserved as-is — add anything you like.
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
[allourthings.io](https://allourthings.io)
|