Skip to content

Commit d3a218f

Browse files
committed
chore: Update CHANGELOG and README for version 0.0.4
- Added version 0.0.4 entry in CHANGELOG.md with patch changes. - Revised README.md to enhance configuration instructions for Cline MCP and Claude Desktop, including examples for local and remote database setups. - Removed outdated changeset file related to previous configuration updates.
1 parent 6999e3f commit d3a218f

3 files changed

Lines changed: 50 additions & 74 deletions

File tree

.changeset/purple-shoes-remain.md

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

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# mcp-memory-libsql
22

3+
## 0.0.4
4+
5+
### Patch Changes
6+
7+
- d2adc33: update config
8+
39
## 0.0.2
410

511
### Patch Changes

README.md

Lines changed: 44 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -11,102 +11,77 @@ A high-performance, persistent memory system for the Model Context Protocol (MCP
1111
- 🌐 Compatible with local and remote libSQL databases
1212
- 🔒 Secure token-based authentication for remote databases
1313

14-
## Installation
14+
## Configuration
1515

16-
```bash
17-
npm install mcp-memory-libsql
18-
```
19-
20-
Or with pnpm:
21-
22-
```bash
23-
pnpm add mcp-memory-libsql
24-
```
25-
26-
## Usage
27-
28-
### Starting the Server
29-
30-
You can start the server using npx:
31-
32-
```bash
33-
npx mcp-memory-libsql
34-
```
35-
36-
### Configuration
16+
This server is designed to be used as part of an MCP configuration. Here are examples for different environments:
3717

38-
The server can be configured by passing environment variables when starting the server:
18+
### Cline Configuration
3919

40-
```bash
41-
# For a local SQLite database:
42-
LIBSQL_URL=file:/path/to/your/database.db npx mcp-memory-libsql
43-
44-
# For a remote libSQL database (e.g., Turso):
45-
LIBSQL_URL=libsql://your-database.turso.io LIBSQL_AUTH_TOKEN=your-auth-token npx mcp-memory-libsql
46-
```
47-
48-
By default, if no URL is provided, it will use `file:/memory-tool.db` in the current directory.
49-
50-
### Claude Desktop Configuration
51-
52-
Add this to your Claude Desktop configuration:
20+
Add this to your Cline MCP settings:
5321

5422
```json
5523
{
5624
"mcpServers": {
57-
"memory": {
25+
"mcp-memory-libsql": {
5826
"command": "npx",
59-
"args": ["-y", "mcp-memory-libsql"]
27+
"args": ["-y", "mcp-memory-libsql"],
28+
"env": {
29+
"LIBSQL_URL": "file:/path/to/your/database.db"
30+
}
6031
}
6132
}
6233
}
6334
```
6435

65-
## Development
66-
67-
### Prerequisites
68-
69-
- Node.js 22.13.0 or higher
70-
- pnpm (recommended) or npm
71-
72-
### Setup
36+
### Claude Desktop with WSL Configuration
7337

74-
1. Clone the repository:
38+
For a detailed guide on setting up this server with Claude Desktop in WSL, see [Getting MCP Server Working with Claude Desktop in WSL](https://scottspence.com/posts/getting-mcp-server-working-with-claude-desktop-in-wsl).
7539

76-
```bash
77-
git clone https://github.com/yourusername/mcp-memory-libsql.git
78-
cd mcp-memory-libsql
79-
```
80-
81-
2. Install dependencies:
40+
Add this to your Claude Desktop configuration for WSL environments:
8241

83-
```bash
84-
pnpm install
42+
```json
43+
{
44+
"mcpServers": {
45+
"mcp-memory-libsql": {
46+
"command": "wsl.exe",
47+
"args": [
48+
"bash",
49+
"-c",
50+
"source ~/.nvm/nvm.sh && LIBSQL_URL=file:/path/to/database.db /home/username/.nvm/versions/node/v20.12.1/bin/npx mcp-memory-libsql"
51+
]
52+
}
53+
}
54+
}
8555
```
8656

87-
3. Run database migrations:
57+
### Database Configuration
8858

89-
```bash
90-
pnpm run migrate
91-
```
59+
The server supports both local SQLite and remote libSQL databases through the LIBSQL_URL environment variable:
9260

93-
4. Build the project:
61+
For local SQLite databases:
9462

95-
```bash
96-
pnpm run build
63+
```json
64+
{
65+
"env": {
66+
"LIBSQL_URL": "file:/path/to/database.db"
67+
}
68+
}
9769
```
9870

99-
### Running Tests
71+
For remote libSQL databases (e.g., Turso):
10072

101-
```bash
102-
pnpm test
73+
```json
74+
{
75+
"env": {
76+
"LIBSQL_URL": "libsql://your-database.turso.io",
77+
"LIBSQL_AUTH_TOKEN": "your-auth-token"
78+
}
79+
}
10380
```
10481

105-
### Development Mode
82+
Note: When using WSL, ensure the database path uses the Linux filesystem format (e.g., `/home/username/...`) rather than Windows format.
10683

107-
```bash
108-
pnpm run dev
109-
```
84+
By default, if no URL is provided, it will use `file:/memory-tool.db` in the current directory.
11085

11186
## API
11287

0 commit comments

Comments
 (0)