You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+82-17Lines changed: 82 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,12 +14,20 @@
14
14
15
15
Home Memory is an [MCP server](https://modelcontextprotocol.io/) that gives your AI assistant structured, persistent knowledge about your home — every room, every device, every pipe and cable, every item you own. It plugs into Claude, OpenAI Codex, or any MCP-compatible AI and turns natural conversation into a living, queryable documentation of your home and everything in it.
16
16
17
-
No app to learn. No forms to fill out. No UI needed — the AI *is* your interface.
17
+
No app to learn. No forms to fill out. Your home data stays in a single file on your machine — the AI *is* your interface.
18
18
19
19
Tell your AI about your heat pump, your car, your power tools, or your wine collection — it extracts the relevant details and stores them as structured data in your local database. Snap a photo of a device or hand it an invoice — same thing. Ask "What's in the basement?" or "When is my car due for inspection?" and get real answers from real data, not hallucinations.
20
20
21
21
<palign="center">
22
-
<imgsrc="docs/demo.png"width="700"alt="Demo: One sentence creates two elements — Claude finds the right categories, creates a missing room, and documents everything.">
22
+
<imgsrc="docs/demo.png"width="700"alt="Demo in Claude Desktop: One sentence creates two elements — the AI finds the right categories, creates a missing room, and documents everything.">
23
+
<br>
24
+
<em>Claude Desktop (Anthropic)</em>
25
+
</p>
26
+
27
+
<palign="center">
28
+
<imgsrc="docs/demo-codex.png"width="700"alt="Demo in Codex App: Same prompt, same result — works across AI clients.">
29
+
<br>
30
+
<em>Codex App (OpenAI)</em>
23
31
</p>
24
32
25
33
## What you can do
@@ -54,31 +62,88 @@ Cable routes, pipe runs, duct paths — documented as connections between elemen
54
62
55
63
Track what's planned, what exists, and what's been removed.
56
64
57
-
## Quick Start
65
+
## Quick Start (Windows)
66
+
67
+
The release ZIP is self-contained — no .NET, no Firebird, no other software to install.
58
68
59
-
### Option 1: Download Release (recommended)
69
+
### 1. Download & Extract
60
70
61
71
1. Download the latest release ZIP from [GitHub Releases](../../releases)
3. Add the `home-memory` entry inside `mcpServers` (keep any existing entries):
102
+
103
+
```json
104
+
"home-memory": {
105
+
"command": "C:\\HomeMemory\\HomeMemoryMCP.exe"
106
+
}
107
+
```
108
+
109
+
4. Save the file and restart Claude Desktop
110
+
111
+
Home Memory is available in the Chat tab.
112
+
113
+
> If you register Home Memory via Claude Code (`claude mcp add`), it may also appear in the Code tab. Avoid defining the same server in both places, as the Desktop configuration can override the Code tab in some versions.
claude mcp add home-memory --scope user -- "C:\HomeMemory\HomeMemoryMCP.exe"
73
122
```
74
123
75
-
4. Start your AI client — done.
124
+
</details>
125
+
126
+
### 3. Try it
127
+
128
+
On first launch, Home Memory automatically creates a local database with over 100 categories and a default house structure (floors, rooms, garage, outdoor areas). No setup wizard needed.
129
+
130
+
**Try these prompts in order:**
76
131
77
-
> **Claude Desktop users:** The Code tab in Claude Desktop shares its configuration with Claude Code. If you registered the server with `claude mcp add`, it is already available in the Code tab — no additional setup needed.
132
+
> "Show me the structure of my home."
78
133
79
-
On first launch, Home Memory automatically creates a local database at `%LOCALAPPDATA%\HomeMemory\homememory.scd` with over 100 categories and a default house structure. No setup wizard, no configuration needed — just start talking, and adapt everything to your home through conversation. To change the database location, set the `HOME_MEMORY_DB_PATH` environment variable (see [Configuration](#configuration)).
134
+
You should see your default house structure: ground floor, upper floor, basement, each with rooms. This confirms everything is working.
80
135
81
-
### Option 2: Build from Source
136
+
> "I have a Bosch washing machine in the basement."
137
+
138
+
Your AI creates the element, finds the right category, and places it in the basement — all in one step. Ask "What's in the basement?" to verify.
139
+
140
+
> "We're planning to install a heat pump in the utility room."
141
+
142
+
Creates a planned element — so you can track what exists and what's coming.
143
+
144
+
**If it works, you're done.** Everything from here is just talking to your AI. Add rooms, rename floors, document your electrical panel, upload a photo of a device — the AI handles the rest.
145
+
146
+
### Build from Source (advanced)
82
147
83
148
Requires [.NET 10 SDK](https://dotnet.microsoft.com/download/dotnet/10.0) and [Firebird 3.0](https://firebirdsql.org/en/firebird-3-0/).
| Claude Desktop (Chat tab) | Tested, production-ready |
198
+
| Claude Desktop (Code tab) | Works via Claude Code registration; see note above |
131
199
| Claude Code (CLI) | Tested, production-ready |
132
-
| Claude Desktop (Code tab) | Works automatically — shares Claude Code configuration |
133
200
| Codex CLI (OpenAI) | Tested, production-ready |
134
-
| Codex App (OpenAI) | Tested, production-ready |
135
201
| Any MCP-compatible client | Should work (stdio transport) |
136
202
137
203
The release ZIP is a self-contained Windows build with all dependencies included (no .NET or Firebird installation required). On macOS and Linux, you can build from source with .NET 10 and Firebird 3 — see the [Setup Guide](docs/SETUP-GUIDE.md) for details.
@@ -148,7 +214,6 @@ The release ZIP is a self-contained Windows build with all dependencies included
148
214
-**.NET 10** with [ModelContextProtocol SDK](https://github.com/modelcontextprotocol/csharp-sdk)
Copy file name to clipboardExpand all lines: docs/SETUP-GUIDE.md
+10-21Lines changed: 10 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Using the Release (recommended)
4
4
5
-
Download the release ZIP from [GitHub Releases](../../releases) and follow the [Quick Start](../README.md#quick-start) in the README. The release is a self-contained build — no .NET SDK and no Firebird installation required.
5
+
Download the release ZIP from [GitHub Releases](../../releases) and follow the [Quick Start](../README.md#quick-start-windows) in the README. The release is a self-contained build — no .NET SDK and no Firebird installation required.
6
6
7
7
## Configuration
8
8
@@ -54,36 +54,25 @@ claude mcp add home-memory --scope user --env "HOME_MEMORY_DB_PATH=/path/to/my-h
The Chat tab in Claude Desktop uses a separate config file from Claude Code. Edit it manually and restart Claude Desktop.
59
+
Open the **Claude menu** → **Settings** → **Developer** → **Edit Config**. This opens the correct config file regardless of how Claude Desktop was installed (Store or direct install).
60
60
61
-
**Config file location:**
62
-
63
-
| Platform | Path |
64
-
|---|---|
65
-
| Windows (Store / direct install) |`%AppData%\Claude\claude_desktop_config.json`|
Omit the `env` block to use the default database location (`%LOCALAPPDATA%\HomeMemory\homememory.scd`).
85
74
86
-
> **Note:**The Code tab in Claude Desktop shares its configuration with Claude Code (`~/.claude.json`) and does not use this file — it picks up Home Memory automatically if you registered it with `claude mcp add`.
75
+
> **Note:**If you register Home Memory via Claude Code (`claude mcp add`), it may also appear in the Code tab. Avoid defining the same server in both the Desktop config and Claude Code, as the Desktop configuration can override the Code tab in some versions.
0 commit comments