Skip to content

Commit 3a5f815

Browse files
committed
Cross-Platform Support & MCP Compliance:
- Windows PowerShell installer (install.ps1) for one-line installation - Centralized config-templates/ folder with platform-specific configs - Cross-platform config generator (scripts/generate-config.py) - Windows cmd /c wrapper support for proper process spawning - Updated MCP SDK version constraint to v1.22-2.0 for stability - Logging configuration to prevent stdout corruption in STDIO mode
1 parent bca30f0 commit 3a5f815

25 files changed

Lines changed: 3389 additions & 112 deletions

.github/workflows/ci.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ on:
55
branches: [ main, fix-storage-health-coroutine-error ]
66
pull_request:
77
branches: [ main ]
8+
schedule:
9+
- cron: '0 12 * * *' # Daily at 12:00 PM UTC
810

911
jobs:
1012
checks:

.gitignore

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,17 @@ env.bak/
6060
venv.bak/
6161

6262
# IDEs and editors
63-
.vscode/
6463
.idea/
6564
*.swp
6665
*.swo
6766
*~
6867

68+
# Generated MCP configuration files (templates are in config-templates/)
69+
.mcp.json
70+
claude_desktop_config.json
71+
.vscode/mcp.json
72+
.antigravity/
73+
6974
# OS generated files
7075
.DS_Store
7176
.DS_Store?
@@ -74,6 +79,7 @@ venv.bak/
7479
.Trashes
7580
ehthumbs.db
7681
Thumbs.db
82+
nul
7783

7884
# Project specific
7985
memory_slots/

.mcp.json.example

Lines changed: 0 additions & 17 deletions
This file was deleted.

.vscode/extensions.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"recommendations": [
3+
"github.copilot",
4+
"github.copilot-chat",
5+
"ms-python.python",
6+
"ms-python.vscode-pylance"
7+
],
8+
"unwantedRecommendations": []
9+
}

README.md

Lines changed: 87 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<img src="assets/image/memcord_1024.png" width="256">
55
</td>
66
<td>
7-
<h3>MEMCORD v2.3.6 (mcp server)</h3>
7+
<h3>MEMCORD v2.3.7 (mcp server)</h3>
88
<p>
99
This privacy-first, self-hosted MCP server helps you organize chat history, summarize messages, search across past chats with AI — and keeps everything secure and fully under your control.
1010
</p>
@@ -32,105 +32,122 @@ Transform your Claude conversations into a searchable, organized knowledge base
3232
* **🎯 Effortless Organization** - Smart tags and folders that organize themselves around your workflow
3333
* **🔗 Intelligent Merging** - Automatically combines related conversations while eliminating duplicates
3434

35-
## What's new in v2.3.6
35+
## What's new in v2.3.7
3636

37-
```text
38-
Google Antigravity IDE Support:
37+
```text
38+
Cross-Platform Support & MCP Compliance:
3939
40-
- Added Google Antigravity configuration template (.antigravity/mcp_config.json)
40+
- Windows PowerShell installer (install.ps1) for one-line installation
41+
- Centralized config-templates/ folder with platform-specific configs
42+
- Cross-platform config generator (scripts/generate-config.py)
43+
- Windows cmd /c wrapper support for proper process spawning
44+
- Updated MCP SDK version constraint to v1.22-2.0 for stability
45+
- Logging configuration to prevent stdout corruption in STDIO mode
46+
```
47+
48+
<details>
49+
<summary>v2.3.6 - Google Antigravity IDE Support</summary>
50+
51+
```text
52+
- Added Google Antigravity IDE configuration template
4153
- Full compatibility with Antigravity's MCP server integration
4254
```
55+
</details>
4356

4457
## 🚀 Quick Start
4558

59+
**macOS / Linux:**
4660
```bash
4761
curl -fsSL https://github.com/ukkit/memcord/raw/main/install.sh | bash
4862
```
4963

64+
**Windows (PowerShell):**
65+
```powershell
66+
irm https://github.com/ukkit/memcord/raw/main/install.ps1 | iex
67+
```
68+
5069
This will:
5170
- Download and setup **memcord**
52-
- Set Up Python Virtual Environment using uv
53-
- Update claude_desktop_config.json & README.md with Installation Path
71+
- Set up Python virtual environment using uv
72+
- Generate platform-specific MCP configuration files
73+
- Configure Claude Desktop, Claude Code, VSCode, and Antigravity IDE
5474

55-
### Manually update existing setup
75+
### Configuration Templates
76+
77+
All MCP configuration templates are in `config-templates/`. After installation, run:
5678

5779
```bash
58-
uv pip install -e .
59-
uv lock
80+
# Regenerate configs (useful after updates or path changes)
81+
uv run python scripts/generate-config.py
82+
83+
# Windows users
84+
uv run python scripts/generate-config.py --platform windows
85+
86+
# Preview changes without writing
87+
uv run python scripts/generate-config.py --dry-run
6088
```
6189

6290
### Claude Desktop
6391

92+
Copy the generated `claude_desktop_config.json` to your Claude Desktop config location:
93+
94+
| Platform | Config Location |
95+
|----------|-----------------|
96+
| macOS | `~/Library/Application Support/Claude/claude_desktop_config.json` |
97+
| Windows | `%APPDATA%\Claude\claude_desktop_config.json` |
98+
| Linux | `~/.config/Claude/claude_desktop_config.json` |
99+
100+
Or use the template from `config-templates/claude-desktop/`:
101+
64102
```json
65103
{
66104
"mcpServers": {
67105
"memcord": {
68106
"command": "uv",
69-
"args": [
70-
"--directory",
71-
"</path/to/memcord>",
72-
"run",
73-
"memcord"
74-
],
107+
"args": ["--directory", "/path/to/memcord", "run", "memcord"],
75108
"env": {
76-
"PYTHONPATH": "</path/to/memcord>/src"
109+
"PYTHONPATH": "/path/to/memcord/src",
110+
"MEMCORD_ENABLE_ADVANCED": "false"
77111
}
78112
}
79113
}
80114
}
81115
```
82116

117+
**Windows users:** Use `config-templates/claude-desktop/config.windows.json` which includes the required `cmd /c` wrapper.
118+
83119
### VSCode with GitHub Copilot
84120

85121
**Prerequisites:**
86122
- VSCode 1.102+ (MCP support is GA)
87123
- GitHub Copilot subscription
88124
- Organization/Enterprise MCP policy enabled (if applicable)
89125

90-
**Option 1: Workspace Configuration (Recommended)**
126+
**Setup:**
91127

92-
Copy the example configuration to your workspace:
128+
The installer creates `.vscode/mcp.json` automatically. Or copy manually:
93129

94130
```bash
95-
mkdir -p .vscode
96-
cp .vscode/mcp.json.example .vscode/mcp.json
131+
cp config-templates/vscode/mcp.json .vscode/mcp.json
97132
```
98133

99-
Or create `.vscode/mcp.json` manually:
134+
The VSCode config uses `${workspaceFolder}` variables, so no path replacement needed:
100135

101136
```json
102137
{
103138
"servers": {
104139
"memcord": {
105140
"command": "uv",
106-
"args": [
107-
"--directory",
108-
"${workspaceFolder}",
109-
"run",
110-
"memcord"
111-
],
141+
"args": ["--directory", "${workspaceFolder}", "run", "memcord"],
112142
"env": {
113-
"PYTHONPATH": "${workspaceFolder}/src"
143+
"PYTHONPATH": "${workspaceFolder}/src",
144+
"MEMCORD_ENABLE_ADVANCED": "false"
114145
}
115146
}
116147
}
117148
}
118149
```
119150

120-
**Option 2: Global User Configuration**
121-
122-
1. Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
123-
2. Run: `MCP: Open User Configuration`
124-
3. Add memcord server configuration to `mcp.json`
125-
126-
**Option 3: Source-Controlled Configuration**
127-
128-
Copy root-level configuration (recommended for teams):
129-
130-
```bash
131-
cp .mcp.json.example .mcp.json
132-
```
133-
134151
**GitHub Copilot Agent Mode:**
135152
Once configured, memcord tools are available in Copilot agent mode. Use natural language:
136153
- "Create a memory slot for this project"
@@ -141,66 +158,73 @@ Once configured, memcord tools are available in Copilot agent mode. Use natural
141158

142159
### Google Antigravity IDE
143160

144-
Add memcord to your `~/.gemini/antigravity/mcp_config.json`:
161+
The installer generates `.antigravity/mcp_config.json` automatically. Or configure manually:
145162

146163
```json
147164
{
148165
"mcpServers": {
149166
"memcord": {
150167
"command": "uv",
151-
"args": [
152-
"--directory",
153-
"</path/to/memcord>",
154-
"run",
155-
"memcord"
156-
],
168+
"args": ["--directory", "/absolute/path/to/memcord", "run", "memcord"],
157169
"env": {
158-
"PYTHONPATH": "</path/to/memcord>/src",
170+
"PYTHONPATH": "/absolute/path/to/memcord/src",
159171
"MEMCORD_ENABLE_ADVANCED": "false"
160172
}
161173
}
162174
}
163175
}
164176
```
165177

166-
> **Note:** Antigravity requires absolute paths. Replace `</path/to/memcord>` with your actual installation path.
167-
168-
See `.antigravity/mcp_config.json` for a template.
178+
> **Note:** Antigravity requires absolute paths.
169179
170180
<img alt="Anti-Gravity screenshot with memcord" src="assets/image/anti-gravity.png">
171181

172-
### Claude Code MCP (🧪 BETA)
182+
### Claude Code CLI
173183

174-
Add MCP server for your project - check README.md for installation path
184+
The installer creates `.mcp.json` in the project root. Or add manually:
175185

176186
```bash
177-
claude mcp add-json memcord '{"type":"stdio","command":"uv","args":["--directory","</path/to/memcord>","run","memcord"],"env":{"PYTHONPATH":"</path/to/memcord>/src"}}'
187+
claude mcp add-json memcord '{"type":"stdio","command":"uv","args":["--directory","/path/to/memcord","run","memcord"],"env":{"PYTHONPATH":"/path/to/memcord/src"}}'
178188
```
179189

180-
Verify installation
190+
**Windows users:** Use `cmd` wrapper:
191+
```powershell
192+
claude mcp add-json memcord '{"type":"stdio","command":"cmd","args":["/c","uv","--directory","C:\\path\\to\\memcord","run","memcord"],"env":{"PYTHONPATH":"C:\\path\\to\\memcord\\src"}}'
193+
```
194+
195+
Verify installation:
181196

182197
```bash
183198
claude mcp list
184199
claude mcp get memcord
185200
```
186201

187-
Add at top of your CLAUDE.md file
202+
Add at top of your CLAUDE.md file:
188203

189204
```bash
190205
memcord_name "NAME_OF_YOUR_PROJECT"
191206
```
192207

193-
### Manual Installaion
208+
### Manual Installation
194209

195210
```bash
196-
# Traditional installation method
197211
git clone https://github.com/ukkit/memcord.git
198212
cd memcord
199213
uv venv
200-
source .venv/bin/activate
214+
source .venv/bin/activate # Windows: .venv\Scripts\Activate.ps1
201215
uv pip install -e .
202216

203-
# Replace </path/to/memcord/> in claude_desktop_config.json to the path where you installed it manually
217+
# Generate configuration files
218+
uv run python scripts/generate-config.py
219+
```
220+
221+
### Update Existing Installation
222+
223+
```bash
224+
cd /path/to/memcord
225+
git pull
226+
uv pip install -e .
227+
uv run python scripts/generate-config.py # Regenerate configs
204228
```
205229

206230
**[Complete Installation Guide](docs/installation.md)** - Detailed setup for Claude Code, Claude Desktop, and other MCP applications.

0 commit comments

Comments
 (0)