Skip to content

Commit df8fed5

Browse files
committed
docs: improved Quick Start, Codex screenshot, bump to v0.1.2
1 parent 677671e commit df8fed5

4 files changed

Lines changed: 93 additions & 39 deletions

File tree

HomeMemoryMCP/HomeMemoryMCP.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<ImplicitUsings>enable</ImplicitUsings>
88
<RootNamespace>HomeMemory.MCP</RootNamespace>
99
<AssemblyName>HomeMemoryMCP</AssemblyName>
10-
<Version>0.1.1</Version>
10+
<Version>0.1.2</Version>
1111
</PropertyGroup>
1212

1313
<ItemGroup>

README.md

Lines changed: 82 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,20 @@
1414

1515
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.
1616

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.
1818

1919
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.
2020

2121
<p align="center">
22-
<img src="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+
<img src="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+
<p align="center">
28+
<img src="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>
2331
</p>
2432

2533
## What you can do
@@ -54,31 +62,88 @@ Cable routes, pipe runs, duct paths — documented as connections between elemen
5462
5563
Track what's planned, what exists, and what's been removed.
5664

57-
## Quick Start
65+
## Quick Start (Windows)
66+
67+
The release ZIP is self-contained — no .NET, no Firebird, no other software to install.
5868

59-
### Option 1: Download Release (recommended)
69+
### 1. Download & Extract
6070

6171
1. Download the latest release ZIP from [GitHub Releases](../../releases)
62-
2. Extract to any folder
63-
3. Register the MCP server:
72+
2. Extract to a folder, e.g. `C:\HomeMemory\`
73+
74+
### 2. Connect to your AI
75+
76+
Choose **one** of the following clients:
77+
78+
<details>
79+
<summary><strong>Codex App (OpenAI)</strong></summary>
6480

65-
**Claude Code:**
81+
1. Open the Codex App
82+
2. Click **File > Settings**, then select **MCP servers** on the left
83+
3. Click **+ Add server**
84+
4. **Name:** `home-memory`
85+
5. **Command to launch:** `C:\HomeMemory\HomeMemoryMCP.exe`
86+
6. Leave transport on **STDIO** (default)
87+
7. Click **Save** — restart the app if needed
88+
89+
Or via Codex CLI:
6690
```bash
67-
claude mcp add home-memory --scope user -- "/path/to/HomeMemoryMCP.exe"
91+
codex mcp add home-memory -- "C:\HomeMemory\HomeMemoryMCP.exe"
6892
```
6993

70-
**OpenAI Codex:**
94+
</details>
95+
96+
<details>
97+
<summary><strong>Claude Desktop</strong></summary>
98+
99+
1. Open Claude Desktop
100+
2. Click the **Claude menu****Settings****Developer****Edit Config**
101+
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.
114+
115+
</details>
116+
117+
<details>
118+
<summary><strong>Claude Code (CLI)</strong></summary>
119+
71120
```bash
72-
codex mcp add home-memory -- "/path/to/HomeMemoryMCP.exe"
121+
claude mcp add home-memory --scope user -- "C:\HomeMemory\HomeMemoryMCP.exe"
73122
```
74123

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:**
76131

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."
78133
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.
80135

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)
82147

83148
Requires [.NET 10 SDK](https://dotnet.microsoft.com/download/dotnet/10.0) and [Firebird 3.0](https://firebirdsql.org/en/firebird-3-0/).
84149

@@ -128,10 +193,11 @@ Electrical (circuits, PV, wallbox, home automation) &middot; HVAC &middot; Plumb
128193

129194
| Client | Status |
130195
|---|---|
196+
| Codex App (OpenAI) | Tested, production-ready |
197+
| Claude Desktop (Chat tab) | Tested, production-ready |
198+
| Claude Desktop (Code tab) | Works via Claude Code registration; see note above |
131199
| Claude Code (CLI) | Tested, production-ready |
132-
| Claude Desktop (Code tab) | Works automatically — shares Claude Code configuration |
133200
| Codex CLI (OpenAI) | Tested, production-ready |
134-
| Codex App (OpenAI) | Tested, production-ready |
135201
| Any MCP-compatible client | Should work (stdio transport) |
136202

137203
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
148214
- **.NET 10** with [ModelContextProtocol SDK](https://github.com/modelcontextprotocol/csharp-sdk)
149215
- **Firebird Embedded** — zero-install database engine, single-file storage
150216
- **Raw SQL** with recursive CTEs — no ORM overhead, transparent and auditable
151-
- **Semantic Versioning** — currently `v0.1.1` (pre-release)
152217

153218
## Contributing
154219

docs/SETUP-GUIDE.md

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Using the Release (recommended)
44

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.
66

77
## Configuration
88

@@ -54,36 +54,25 @@ claude mcp add home-memory --scope user --env "HOME_MEMORY_DB_PATH=/path/to/my-h
5454
codex mcp add home-memory --env "HOME_MEMORY_DB_PATH=/path/to/my-home.scd" -- "/path/to/HomeMemoryMCP.exe"
5555
```
5656

57-
### Claude Desktop (Chat tab)
57+
### Claude Desktop
5858

59-
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).
6060

61-
**Config file location:**
62-
63-
| Platform | Path |
64-
|---|---|
65-
| Windows (Store / direct install) | `%AppData%\Claude\claude_desktop_config.json` |
66-
| macOS | `~/Library/Application Support/Claude/claude_desktop_config.json` |
67-
68-
Add the `mcpServers` entry (create the file if it doesn't exist):
61+
Add the `home-memory` entry inside `mcpServers` (keep any existing entries):
6962

7063
```json
71-
{
72-
"mcpServers": {
73-
"home-memory": {
74-
"command": "C:\\path\\to\\HomeMemoryMCP.exe",
75-
"args": [],
76-
"env": {
77-
"HOME_MEMORY_DB_PATH": "C:\\path\\to\\my-home.scd"
78-
}
79-
}
64+
"home-memory": {
65+
"command": "C:\\path\\to\\HomeMemoryMCP.exe",
66+
"args": [],
67+
"env": {
68+
"HOME_MEMORY_DB_PATH": "C:\\path\\to\\my-home.scd"
8069
}
8170
}
8271
```
8372

8473
Omit the `env` block to use the default database location (`%LOCALAPPDATA%\HomeMemory\homememory.scd`).
8574

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.
8776
8877
### Managing registrations
8978

docs/demo-codex.png

146 KB
Loading

0 commit comments

Comments
 (0)